Docs

開発環境セットアップ

1. dockerをインストール

2. プロジェクトディレクトリ下で以下を実行

docker compose run --rm nextjs yarn

3. プロジェクトディレクトリをVScodeで開く

4. Dev Containerの拡張機能をインストールしていなければインストールする

5. F1を押し、コマンドパレットから「コンテナで再度開く」を押す

6. コンソールで以下を実行

bin/setup
rails db:setup
rails db:seed

7. 以下を実行してサーバーを立ち上げ

rails s -b 0.0.0.0

ローカル環境は以下のURL http://localhost:4000/

仕様書の確認

1. 開発用のDevContainerを開く
2. ./openapi/openapi.ymlファイルを開く
3. コマンドパレットを開き、Preview Swaggerを選択

仕様書を使った簡易テスト

Try it out → Executeでサーバーにリクエストを投げることができる

HTML形式の仕様書

簡易版はopenapi-static.htmlをブラウザで開くと確認できる

モックサーバーを導入

1. プロジェクトディレクトリで以下を実行

npm install -g @stoplight/prism-cli

以下を実行してモックサーバー起動

prism mock openapi/openapi.yml