Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs:API周りのドキュメントを作成 #72

Merged
merged 2 commits into from
Dec 2, 2024
Merged

docs:API周りのドキュメントを作成 #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2d875c
docs:API周りのドキュメントを作成
mathsuky Dec 2, 2024
0f7293a
fix:パスの抜けを修正
mathsuky Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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を叩いてください。