codeforjapan / BirdXplorer

7 stars 1 forks source link

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

Closed yu23ki14 closed 3 weeks ago

yu23ki14 commented 1 month ago

改善詳細 / Details of Improvement

Swagger

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

Readme

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