README

Rails で API(GraphQL)を作るためのテンプレート

https://qiita.com/ham0215/items/54287e3793ed81558425

docker

docker build

docker compose up --build -d

Database initialize

docker compose exec api rails db:create
docker compose exec api rails db:schema:load
docker compose exec api rails db:test:prepare
docker compose exec api rails db:seed_fu

Run rails server

docker compose exec api rails s -b 0.0.0.0

GraphQL

create schema

下記コマンドでスキーマファイルを生成できます。

docker compose exec api rails graphql:schema:dump

GraphiQL

http://localhost:3001/graphiql

create document

manual

gqldoc を使って GraphQL のドキュメントを生成しています。

https://github.com/Code-Hex/gqldoc

# 下記コマンドで生成
# * brewでインストールしておくこと
gqldoc -s docs/graphql/schema.graphql -o docs/gqldoc

#### automatic

下記の Github Actions を使って main ブランチに PUSH したときに自動生成している

https://github.com/Code-Hex/gqldoc-actions

tables ( using tbls )

テーブル定義

https://github.com/ham0215/rails_api_base/blob/main/docs/tables/README.md

生成方法

下記コマンドでドキュメントを生成します。 docs/tables に出力されます。

docker-compose run --rm tbls doc --force

ci で mysql のスキーマとドキュメントが一致していることを確認しています。

ref: https://github.com/k1LoW/tbls

sidekiq

sidekiq -q default -q mailers

http://localhost:3001/sidekiq

credentials

シークレット情報は credentials に格納している

# edit credentials. env: development, test
docker-compose exec api rails credentials:edit --environment $env