# OpenAPI の追加レスポンス { #additional-responses-in-openapi }

/// warning | 注意

これは比較的高度なトピックです。

FastAPI を使い始めたばかりであれば、これは不要かもしれません。

///

追加のステータスコード、メディアタイプ、説明などを伴う追加レスポンスを宣言できます。

それらの追加レスポンスは OpenAPI スキーマに含まれ、API ドキュメントにも表示されます。

ただし、それらの追加レスポンスについては、ステータスコードとコンテンツを指定して `JSONResponse` などの `Response` を直接返す必要があります。

## `model` を使った追加レスポンス { #additional-response-with-model }

*path operation デコレータ*に `responses` パラメータを渡せます。

# OpenAPI 中的附加响应 { #additional-responses-in-openapi }

/// warning | 警告

这是一个相对高级的话题。

如果你刚开始使用 **FastAPI**，可能暂时用不到。

///

你可以声明附加响应，包括额外的状态码、媒体类型、描述等。

这些附加响应会被包含在 OpenAPI 模式中，因此它们也会出现在 API 文档中。

但是对于这些附加响应，你必须确保直接返回一个 `Response`（例如 `JSONResponse`），并携带你的状态码和内容。

## 带有 `model` 的附加响应 { #additional-response-with-model }

你可以向你的*路径操作装饰器*传入参数 `responses`。

它接收一个 `dict`：键是每个响应的状态码（例如 `200`），值是包含该响应信息的另一个 `dict`。

# Additional Responses in OpenAPI { #additional-responses-in-openapi }

/// warning

This is a rather advanced topic.

If you are starting with **FastAPI**, you might not need this.

///

You can declare additional responses, with additional status codes, media types, descriptions, etc.

Those additional responses will be included in the OpenAPI schema, so they will also appear in the API docs.

# Additional Status Codes { #additional-status-codes }

By default, **FastAPI** will return the responses using a `JSONResponse`, putting the content you return from your *path operation* inside of that `JSONResponse`.

It will use the default status code or the one you set in your *path operation*.

## Additional status codes { #additional-status-codes_1 }

# 額外的狀態碼 { #additional-status-codes }

在預設情況下，**FastAPI** 會使用 `JSONResponse` 傳回回應，並把你從你的「路徑操作（path operation）」回傳的內容放進該 `JSONResponse` 中。

它會使用預設的狀態碼，或你在路徑操作中設定的狀態碼。

## 額外的狀態碼 { #additional-status-codes_1 }

如果你想在主要狀態碼之外再回傳其他狀態碼，可以直接回傳一個 `Response`（例如 `JSONResponse`），並直接設定你想要的額外狀態碼。

例如，你想要有一個允許更新項目的路徑操作，成功時回傳 HTTP 狀態碼 200 "OK"。

但你也希望它能接受新項目；當項目先前不存在時就建立它們，並回傳 HTTP 狀態碼 201 "Created"。

要達成這點，匯入 `JSONResponse`，直接在那裡回傳內容，並設定你想要的 `status_code`：

# 追加のステータスコード { #additional-status-codes }

デフォルトでは、 **FastAPI** は `JSONResponse` を使ってレスポンスを返し、*path operation* から返した内容をその `JSONResponse` の中に入れます。

デフォルトのステータスコード、または *path operation* で設定したステータスコードが使用されます。

## 追加のステータスコード { #additional-status-codes_1 }

メインのステータスコードとは別に追加のステータスコードを返したい場合は、`JSONResponse` のような `Response` を直接返し、追加のステータスコードを直接設定できます。

たとえば、item を更新でき、成功時に HTTP ステータスコード 200 "OK" を返す *path operation* を作りたいとします。

# OpenAPI'de Ek Response'lar { #additional-responses-in-openapi }

/// warning | Uyarı

Bu konu oldukça ileri seviye bir konudur.

**FastAPI**'ye yeni başlıyorsanız buna ihtiyaç duymayabilirsiniz.

///

Ek status code'lar, media type'lar, açıklamalar vb. ile ek response'lar tanımlayabilirsiniz.

Bu ek response'lar OpenAPI şemasına dahil edilir; dolayısıyla API dokümanlarında da görünürler.

# Réponses supplémentaires dans OpenAPI { #additional-responses-in-openapi }

/// warning | Alertes

Ceci concerne un sujet plutôt avancé.

Si vous débutez avec **FastAPI**, vous n'en aurez peut-être pas besoin.

///

Vous pouvez déclarer des réponses supplémentaires, avec des codes d'état supplémentaires, des types de médias, des descriptions, etc.

# Дополнительные ответы в OpenAPI { #additional-responses-in-openapi }

/// warning | Предупреждение

Это довольно продвинутая тема.

Если вы только начинаете работать с **FastAPI**, возможно, вам это пока не нужно.

///

Вы можете объявлять дополнительные ответы с дополнительными статус-кодами, типами содержимого, описаниями и т.д.

Эти дополнительные ответы будут включены в схему OpenAPI, и поэтому появятся в документации API.

# OpenAPI 中的額外回應 { #additional-responses-in-openapi }

/// warning | 警告

這是一個偏進階的主題。

如果你剛開始使用 **FastAPI**，大多情況下不需要用到它。

///

你可以宣告額外的回應，包含額外的狀態碼、媒體型別、描述等。

這些額外回應會被包含在 OpenAPI 中，因此也會顯示在 API 文件裡。

但對於這些額外回應，你必須直接回傳像 `JSONResponse` 這樣的 `Response`，並包含你的狀態碼與內容。

## 使用 `model` 的額外回應 { #additional-response-with-model }

你可以在你的「路徑操作裝飾器」中傳入參數 `responses`。

它接收一個 `dict`：鍵是各回應的狀態碼（例如 `200`），值是另一個 `dict`，其中包含每個回應的資訊。