ChatGPT で API サーバー(Golang, gin)をさくっと作る

最近は ChatGPT と一番会話をしてる気がします。。。

今回はそんな GhatGPT さんに Go の API サーバーの記述をお願いしたら、思ったより面白いことになったのでその紹介です。
（生成いただいた内容は github においてあります。）

TOC

やりとり
確認
- /health
- /hello
- /group
感想

やりとり

これが私の発言で

これが ChatGPT さんの発言です。

今回は、こちらで変更することなく一発で動くものを出していただきました！

API サーバーを立ててもらう

Go で API サーバーを作りたいのですが、以下の条件でコードを生成していただけますでしょうか？
・適切にパッケージ分割を行い、クリーンアーキテクチャに則った構成にする
・プロジェクトのパッケージ名は "chat-gpt" でお願いします
・web フレームワークは gin を使う
・ローカルには postgresql が 5432 のポート番号で起動している
　・ユーザー名は root, パスワードは rootpassword, データベース名は postgresql とする
　・groups という初期テーブルが存在しており、id が int で name が VARCHAR(20) で定義されている
・作って欲しいエンドポイントは次の 3 つです
　・/health にアクセスした時は {"status": "ok"} という json を response body とする
　・/hello にアクセスした時は name というクエリパラメーターを受け取り、{"greeting": "hello "} という json の response body とする。ただしには受け取ったクエリパラメーターを入れてください
　・/group にアクセスした時は、postgresql に定義された groups というテーブルのグループ情報を全権取得し、json として返す。
　　・例: [{"id": 1, "name": "a"}, {"id": 2, "name": "abb"}]
よろしくお願いします。

以下のような Go 言語のコードを生成します：

出力された Go のコードを表示

package main

import (
    "database/sql"
    "fmt"
    "net/http"

    "github.com/gin-gonic/gin"
    _ "github.com/lib/pq"
)

type Group struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
}

func main() {
    db, err := sql.Open("postgres", "user=root password=rootpassword dbname=postgres sslmode=disable")
    if err != nil {
        fmt.Println(err)
        return
    }
    defer db.Close()

    router := gin.Default()

    router.GET("/health", func(c *gin.Context) {
        c.JSON(http.StatusOK, gin.H{
            "status": "ok",
        })
    })

    router.GET("/hello", func(c *gin.Context) {
        name := c.Query("name")
        c.JSON(http.StatusOK, gin.H{
            "greeting": fmt.Sprintf("hello %s", name),
        })
    })

    router.GET("/group", func(c *gin.Context) {
        rows, err := db.Query("SELECT * FROM groups")
        if err != nil {
            fmt.Println(err)
            c.AbortWithStatus(http.StatusInternalServerError)
            return
        }
        defer rows.Close()

        var groups []Group
        for rows.Next() {
            var group Group
            if err := rows.Scan(&group.ID, &group.Name); err != nil {
                fmt.Println(err)
                c.AbortWithStatus(http.StatusInternalServerError)
                return
            }
            groups = append(groups, group)
        }

        c.JSON(http.StatusOK, groups)
    })

    router.Run(":8080")
}

上記のコードは、gin という web フレームワークを使って API サーバーを構築しています。また、postgresql データベースに接続し、groups テーブルからグループ情報を取得するエンドポイントを定義しています。/health、/hello、/group エンドポイントで指定されたリクエストに応じて適切なレスポンスを返します。

ありがとうございます。
今は 1 つのファイルに記述いただいてますが、クリーンアーキテクチャを意識してパッケージを綺麗に分割することは可能ですか？

はい、可能です。クリーンアーキテクチャは、モジュール（パッケージ）を分割することによって、責任を明確にしてコードを保守しやすくすることを目的としています。上記のコードを複数のパッケージに分割することで、以下のようなメリットがあります：
・各パッケージは独立して開発やテストができるようになります。
・パッケージ間の依存関係が明確になり、責任の明確化が図れます。
・API サーバーの構造がわかりやすくなります。
・修正や改善がしやすくなります。

以上が、クリーンアーキテクチャでパッケージ分割を行うメリットです。

先ほどの gin サーバーの例を、パッケージ分割して示していただけますか？

はい、分割した例を以下に示します。

出力された Go のコードを表示

main.go

package main

import (
    "github.com/gin-gonic/gin"
    "chat-gpt/controller"
    "chat-gpt/service"
)

func main() {
    db := service.ConnectDB()
    defer db.Close()

    r := gin.Default()
    controller.ApplyRoutes(r)
    r.Run()
}

service/database.go

package service

import (
    "database/sql"
    "fmt"
    _ "github.com/lib/pq"
)

func ConnectDB() *sql.DB {
    connStr := "user=root password=rootpassword dbname=postgresql sslmode=disable"
    db, err := sql.Open("postgres", connStr)
    if err != nil {
        fmt.Println(err)
        return nil
    }
    return db
}

controller/routes.go

package controller

import (
    "github.com/gin-gonic/gin"
    "chat-gpt/service"
)

func ApplyRoutes(r *gin.Engine) {
    db := service.ConnectDB()

    r.GET("/health", func(c *gin.Context) {
        c.JSON(200, gin.H{"status": "ok"})
    })

    r.GET("/hello", func(c *gin.Context) {
        name := c.Query("name")
        c.JSON(200, gin.H{"greeting": "hello " + name})
    })

    r.GET("/group", func(c *gin.Context) {
        var groups []service.Group
        rows, err := db.Query("SELECT * FROM groups")
        if err != nil {
            fmt.Println(err)
            c.JSON(500, gin.H{"error": "internal server error"})
            return
        }
        defer rows.Close()
        for rows.Next() {
            var g service.Group
            err := rows.Scan(&g.ID, &g.Name)
            if err != nil {
                fmt.Println(err)
                c.JSON(500, gin.H{"error": "internal server error"})
                return
            }
            groups = append(groups, g)
        }
        c.JSON(200, groups)
    })
}

service/model.go

package service

type Group struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
}

postgresql も立ててもらう

何から何まで誠に恐縮ですが、以下のような postgres を起動するための docker-compose ファイルを教えていただきたいです。・ローカルから見たい際に 5432 のポート番号で起動する・ユーザー名は root, パスワードは rootpassword, データベース名は postgresql とする・groups という初期テーブルが存在しており、id が int で name が VARCHAR(20) で定義されているよろしくお願いいたします。

以下のような docker-compose.yml ファイルになります。

version: "3"
services:
  postgresql:
    image: postgres
    ports:
      - "5432:5432"
    environment:
      POSTGRES_PASSWORD: rootpassword
      POSTGRES_USER: root
      POSTGRES_DB: postgresql
    volumes:
      - ./init.sql:/docker-entrypoint-initdb.d/init.sql

init.sql は初期テーブルとして groups を定義するための sql スクリプトになります。

CREATE TABLE groups (
    id SERIAL PRIMARY KEY,
    name VARCHAR(20) NOT NULL
);

docker-compose up で postgresql が起動すると、ローカルの 5432 ポートで接続できます。
また、init.sql で定義した初期テーブルを見ることができます。

README も書いてもらう

上の API サーバーの例で、README を書くとしたどんな内容になるか教えてください

以下は、上の API サーバーの例に対する README のサンプル内容です。

# API Server Example

このリポジトリは、RESTful API サーバーの例題です。以下の機能を持ちます。

- グループの一覧表示

## 動かし方

1. 事前準備として、PostgreSQL が必要です。以下のコマンドで PostgreSQL をインストールします。

<pre class="code lang-sh" data-lang="sh" data-unlink><span class="synComment"># Debian-based systems</span>
$ sudo apt-get update
$ sudo apt-get install postgresql postgresql-contrib

<span class="synComment"># Red Hat-based systems</span>
$ sudo yum update
$ sudo yum install postgresql postgresql-server
</pre>

2. データベースを作成します。以下の SQL を実行します。

<pre class="code lang-sh" data-lang="sh" data-unlink>$ psql <span class="synSpecial">-U</span> postgres
<span class="synIdentifier">postgres</span>=# CREATE DATABASE api_server_example;
<span class="synIdentifier">postgres</span>=# \q
</pre>

3. テーブルを作成します。以下の SQL を実行します。

<pre class="code lang-sh" data-lang="sh" data-unlink>$ psql <span class="synSpecial">-U</span> postgres api_server_example
<span class="synIdentifier">api_server_example</span>=# CREATE TABLE groups <span class="synPreProc">(</span><span class="synSpecial">id SERIAL PRIMARY KEY, name TEXT NOT NULL</span><span class="synPreProc">)</span>;
<span class="synIdentifier">api_server_example</span>=# \q
</pre>

4. API サーバーを起動します。以下のコマンドを実行します。

<pre class="code lang-sh" data-lang="sh" data-unlink>$ go run main.go
</pre>

5. API を利用するには、以下のエンドポイントに対して HTTP リクエストを送信します。

- GET /groups: グループの一覧を取得します。

## 開発環境

Go 1.16.3

丁寧な README をありがとうございます。 README を書くときに意識していることはありますか？

Yes, here are some things to keep in mind when writing a README:

Audience: Who is the intended audience for your project? Make sure the tone and language in your README is appropriate for that audience.
Purpose: Clearly explain what your project does and what problem it solves.
Getting started: Provide step-by-step instructions on how to set up and use your project.
Features: List the key features and capabilities of your project.
Screenshots or demo: Include screenshots or a demo video to give users a visual understanding of your project.
Technical details: Explain the technical details of your project such as architecture, technology stack, and dependencies.
Contributions: Provide information on how to contribute to your project, including contributing guidelines and a code of conduct.
License: Include the license under which your project is released.
Contact information: Provide contact information for users to reach out to you with questions or feedback.
Future plans: Outline future plans for the project, including planned features and timelines.

そのほかに試したこと

godoc も生成してもらったが、英語で記載された
同じ文章で試しても、パッケージ構成が結構変わる！
テストも書いてもらったりした！

確認

指示したことができているか、実動を確認してみます。

/health

完璧です。

/hello

完璧です。

/group

DB の結果が 0 件の時に null が帰ってきてしまいました。これは完全に自分の考慮・指示漏れです。申し訳ございません。

中身がある時はきちんと表示できてそうです！

感想

思った 3 倍はまともに書いてくれた
レスポンスが長文になった時、『続けてください』などと言えば続けてくれるが、結構な確率で内容が噛み合わなくなる
- 他のパッケージとの整合性が取れなくなってしまう
使いすぎると制限がかかるのがしんどい、辛い
要約してもらうのとか面白い
何故か突如英語で返信きて笑う

Diary

日々学んだことをアウトプットする場として初めてみました