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

Jump to bottom

APIのswaggerとreadmeを充実させる #122

Open

yu23ki14 opened this issue Oct 15, 2024 · 0 comments

Assignees

Collaborator

yu23ki14 commented Oct 15, 2024

改善詳細 / Details of Improvement

Swagger

ParameterのDescriptionとExampleの拡充
Response Exampleがどのフィールドがどういう意味なのかを記述

Readme

Example usecaseみたいなセクションをつくって、そこにシナリオに沿って叩く例をおく。
Ex. トピックに紐づくNotesとPostsを取得する。特定のワードが含まれるPostsに紐づくNotesを取得するなど。

sushichan044 self-assigned this

sushichan044 mentioned this issue

Swagger UI 上のドキュメントを整備する #126

Draft

16 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment