読み方のヒント

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

第5節 API仕様の読み方

5.1 /docs と openapi.json

/docs の画面は、http://127.0.0.1:8000/openapi.json にある仕様から作られています。仕様は、OpenAPIという決まった形式のJSONです。

/docs で POST /reservations を開くと、次の内容が読み取れます。

欄内容
Request bodyname、pickupAt、items の形と型。必須の項目
Responses の 201成功したときの ReservationOut の形
Responses の 422失敗したときの形

「Schema」の切り替えを押すと、quantity の最小値1と最大値10のような、モデルに書いた条件も表示されます。モデルに条件を書いておくと、仕様にも同じ条件が載ります。

18 / 20