Go API Template

go の API のテンプレートリポジトリです

✨ Getting Started

環境の初期化を行う

make set-up

docker環境を起動する

make up

APIを叩いてみる

curl --location --request GET 'localhost:8080/users/1'

以下のように返ってきたらOK

response

{
    "id": 1,
    "name": "hoge1",
    "created_at": "2023-03-01T10:35:33Z"
}

🌿 Directory

DIはpkg/adapter/http/handlerでまとめて行います

.
├── Makefile
├── README.md
├── cmd
│   └── api // api起動
├── docker
│   ├── dev
│   │   ├── api
│   │   │   └── Dockerfile
│   │   └── db
│   │       └── mysql
│   │           ├── Dockerfile
│   │           └── initdb.d // mysql初期化sql
│   └── prod
│       └── api
│           └── Dockerfile
├── docker-compose.yml
├── go.mod
├── go.sum
├── pkg
│   ├── adapter
│   │   └── http // http層
│   │       ├── handler // 各APIのDIはここでする
│   │       ├── middleware
│   │       ├── response
│   │       └── router
│   ├── domain
│   │   ├── model // ビジネスロジック
│   │   └── repository // pkg/infra/persistanceの抽象
│   ├── env // 環境変数初期化
│   ├── infra
│   │   ├── dto // dbとやりとりするための構造体
│   │   ├── mysql // mysql接続ロジック
│   │   ├── persistence // domain/repositoryの具体
│   │   └── registry // cmd/api/server.goで呼び出されるrepositoryの初期化
│   ├── interactor // usecaseの具体
│   │   └── mock // usecaseのmockをまとめる
│   └── usecase // usecaseの抽象
├── scripts // 環境構築時に必要なスクリプトなど

❓ Tips

makeのhelpを表示する

make or make help

help                 helpを表示する
up                   docker環境を立ち上げる
down                 docker環境を閉じる
re                   volumesを削除してdocker環境を立ち上げる
log                  docker環境のログを標示する
go-fmt               goのコードを整形します
set-up               環境の初期化を行います