Merge pull request #72 from traP-jp/docs/add-about-mockserver

docs:API周りのドキュメントを作成
traP-jp · Dec 2, 2024 · 41d9507 · 41d9507
2 parents ff66970 + 0f7293a
commit 41d9507
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,3 +39,12 @@ npm run build
 ```sh
 npm run lint
 ```
+
+## API周りのコード生成の仕方
+
+`./scripts/gen-api.sh`を実行してください。APIを利用する部分については，生成されたコードを使って実装をしてください。
+
+## mockサーバーの立ち上げ方
+
+開発環境においては，モックサーバーを利用します。モックサーバーの立ち上げには`./scripts/run-mock-api.sh`を実行してください。
+このファイルを実行すると`localhost:4010`にモックサーバーが立ち上がりますので，ここで提供されるAPIを叩いてください。