Browse Source
Co-authored-by: Taki Komiyama <[email protected]> Co-authored-by: T. Tokusumi <[email protected]>pull/2476/head
committed by
GitHub
2 changed files with 39 additions and 1 deletions
@ -0,0 +1,37 @@ |
|||
# 追加のステータスコード |
|||
|
|||
デフォルトでは、 **FastAPI** は `JSONResponse` を使ってレスポンスを返します。その `JSONResponse` の中には、 *path operation* が返した内容が入ります。 |
|||
|
|||
それは、デフォルトのステータスコードか、 *path operation* でセットしたものを利用します。 |
|||
|
|||
## 追加のステータスコード |
|||
|
|||
メインのステータスコードとは別に、他のステータスコードを返したい場合は、`Response` (`JSONResponse` など) に追加のステータスコードを設定して直接返します。 |
|||
|
|||
例えば、itemを更新し、成功した場合は200 "OK"のHTTPステータスコードを返す *path operation* を作りたいとします。 |
|||
|
|||
しかし、新しいitemも許可したいです。itemが存在しない場合は、それらを作成して201 "Created"を返します。 |
|||
|
|||
これを達成するには、 `JSONResponse` をインポートし、 `status_code` を設定して直接内容を返します。 |
|||
|
|||
```Python hl_lines="4 23" |
|||
{!../../../docs_src/additional_status_codes/tutorial001.py!} |
|||
``` |
|||
|
|||
!!! warning "注意" |
|||
上記の例のように `Response` を明示的に返す場合、それは直接返されます。 |
|||
|
|||
モデルなどはシリアライズされません。 |
|||
|
|||
必要なデータが含まれていることや、値が有効なJSONであること (`JSONResponse` を使う場合) を確認してください。 |
|||
|
|||
!!! note "技術詳細" |
|||
`from starlette.responses import JSONResponse` を利用することもできます。 |
|||
|
|||
**FastAPI** は `fastapi.responses` と同じ `starlette.responses` を、開発者の利便性のために提供しています。しかし有効なレスポンスはほとんどStarletteから来ています。 `status` についても同じです。 |
|||
|
|||
## OpenAPIとAPIドキュメント |
|||
|
|||
ステータスコードとレスポンスを直接返す場合、それらはOpenAPIスキーマ (APIドキュメント) には含まれません。なぜなら、FastAPIは何が返されるのか事前に知ることができないからです。 |
|||
|
|||
しかし、 [Additional Responses](additional-responses.md){.internal-link target=_blank} を使ってコードの中にドキュメントを書くことができます。 |
Loading…
Reference in new issue