search

qin-team-recipe / 03-recipe-app-backend

0 stars 0 forks source link

readme

使用技術

セットアップ

APIサーバーの起動

air

マイグレーション

  1. app コンテナのターミナルを開く
  2. 以下のコメントを実行してスキーマ、テーブルなどを作成 
    migrate -database ${POSTGRES_URL} -path db/migrations up

    スキーマに変更を加える場合

  3. 以下のコマンドを実行 
    migrate create -ext sql -dir db/migrations -seq [変更内容]
  4. db/migrationsの中に新規で下記のようなファイルが作成されるため、[変更内容].up.sqlに変更するSQLを書き、[変更内容].down.sqlには変更前に戻すSQLを書く 
    000001_[変更内容].down.sql
000001_[変更内容].up.sql

golang-migrateのチュートリアルも参考にしてください！

psqlを使ってDBにアクセスする場合

psql ${POSTGRES_URL}

OpenAPI Specification

Stoplight Studioで各APIの仕様は次のURLをみてください。

yaml からコード生成

oapi-codegen -config docs/config.yaml docs/openapi.yaml > docs/openapi.gen.go

docs/openapi.gen.go に作成されるInterfaceに沿ってAPIを開発してください。

Git コミットルール

Conventional Commits に従う。