コンテンツにスキップ

API仕様

API仕様は OpenAPI を正本として管理します。

正本

  • OpenAPI: openapi/openapi.json
  • 参照Markdown: docs/api/openapi.md
  • 元情報: FastAPI app の /openapi.json

基本方針

  • FastAPI から生成される OpenAPI を一次情報にする。
  • API追加時は OpenAPI の差分を PR に含める。
  • 型生成、SDK生成、Mock、APIテストへ接続できる形式を維持する。