3. api document
Date: 2024-07-22
Status
Accepted
Context
ホスティングされているAPI群のAPI仕様を確認し、どういったユースケースがカバーされているか容易にチェックしたい場面が多くある。どこかにAPI仕様ドキュメントをホスティングし、確認できる状態にしておきたい。
Decision
swagger UIをベースとしたAPIドキュメントの静的サイトをビルドし、Netlifyでホスティングする。OpenAPIの定義ファイルは、FastAPIによって生成されたものから取得する。
Future work
まずは最小コストで導入しやすい部分から始めたが、今後APIテストや動作確認向けの環境などを考慮したい場合は、postmanのAPIドキュメントツールは有望であるように思える。postmanでは監視機能などもあり、今後の移行先として検討する。