読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第5節 API仕様の読み方

第5節のまとめ

  • /docs は、FastAPIが作るOpenAPIの仕様(/openapi.json)から表示される
  • モデルに書いた型や範囲の条件は、仕様にも載る
  • responses に失敗の応答のモデルを書くと、規則の違反の形も仕様に載る
  • code の一覧を渡すと、APIを使う人が失敗の種類ごとに表示を変えられる

20 / 20