tiangolo.fastapi/docs/em/docs/advanced/additional-responses.md

🌖 📨 🗄

/// warning

👉 👍 🏧 ❔.

🚥 👆 ▶️ ⏮️ FastAPI, 👆 💪 🚫 💪 👉.

///

👆 💪 📣 🌖 📨, ⏮️ 🌖 👔 📟, 🔉 🆎, 📛, ♒️.

👈 🌖 📨 🔜 🔌 🗄 🔗, 👫 🔜 😑 🛠️ 🩺.

✋️ 👈 🌖 📨 👆 ✔️ ⚒ 💭 👆 📨 Response 💖 JSONResponse 🔗, ⏮️ 👆 👔 📟 & 🎚.

🌖 📨 ⏮️ model

👆 💪 🚶‍♀️ 👆 ➡ 🛠️ 👨‍🎨 🔢 responses.

⚫️ 📨 dict, 🔑 👔 📟 🔠 📨, 💖 200, & 💲 🎏 dictⓂ ⏮️ ℹ 🔠 👫.

🔠 👈 📨 dictⓂ 💪 ✔️ 🔑 model, ⚗ Pydantic 🏷, 💖 response_model.

FastAPI 🔜 ✊ 👈 🏷, 🏗 🚮 🎻 🔗 & 🔌 ⚫️ ☑ 🥉 🗄.

🖼, 📣 ➕1️⃣ 📨 ⏮️ 👔 📟 404 & Pydantic 🏷 Message, 👆 💪 ✍:

{* ../../docs_src/additional_responses/tutorial001.py hl[18,22] *}

/// note

✔️ 🤯 👈 👆 ✔️ 📨 JSONResponse 🔗.

///

/// info

model 🔑 🚫 🍕 🗄.

FastAPI 🔜 ✊ Pydantic 🏷 ⚪️➡️ 📤, 🏗 JSON Schema, & 🚮 ⚫️ ☑ 🥉.

☑ 🥉:

• 🔑 content, 👈 ✔️ 💲 ➕1️⃣ 🎻 🎚 (dict) 👈 🔌:
  • 🔑 ⏮️ 📻 🆎, ✅ application/json, 👈 🔌 💲 ➕1️⃣ 🎻 🎚, 👈 🔌:
    • 🔑 schema, 👈 ✔️ 💲 🎻 🔗 ⚪️➡️ 🏷, 📥 ☑ 🥉.
      • FastAPI 🚮 🔗 📥 🌐 🎻 🔗 ➕1️⃣ 🥉 👆 🗄 ↩️ ✅ ⚫️ 🔗. 👉 🌌, 🎏 🈸 & 👩‍💻 💪 ⚙️ 👈 🎻 🔗 🔗, 🚚 👻 📟 ⚡ 🧰, ♒️.

///

🏗 📨 🗄 👉 ➡ 🛠️ 🔜:

{
    "responses": {
        "404": {
            "description": "Additional Response",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/Message"
                    }
                }
            }
        },
        "200": {
            "description": "Successful Response",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/Item"
                    }
                }
            }
        },
        "422": {
            "description": "Validation Error",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/HTTPValidationError"
                    }
                }
            }
        }
    }
}

🔗 🔗 ➕1️⃣ 🥉 🔘 🗄 🔗:

{
    "components": {
        "schemas": {
            "Message": {
                "title": "Message",
                "required": [
                    "message"
                ],
                "type": "object",
                "properties": {
                    "message": {
                        "title": "Message",
                        "type": "string"
                    }
                }
            },
            "Item": {
                "title": "Item",
                "required": [
                    "id",
                    "value"
                ],
                "type": "object",
                "properties": {
                    "id": {
                        "title": "Id",
                        "type": "string"
                    },
                    "value": {
                        "title": "Value",
                        "type": "string"
                    }
                }
            },
            "ValidationError": {
                "title": "ValidationError",
                "required": [
                    "loc",
                    "msg",
                    "type"
                ],
                "type": "object",
                "properties": {
                    "loc": {
                        "title": "Location",
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "msg": {
                        "title": "Message",
                        "type": "string"
                    },
                    "type": {
                        "title": "Error Type",
                        "type": "string"
                    }
                }
            },
            "HTTPValidationError": {
                "title": "HTTPValidationError",
                "type": "object",
                "properties": {
                    "detail": {
                        "title": "Detail",
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/ValidationError"
                        }
                    }
                }
            }
        }
    }
}

🌖 🔉 🆎 👑 📨

👆 💪 ⚙️ 👉 🎏 responses 🔢 🚮 🎏 🔉 🆎 🎏 👑 📨.

🖼, 👆 💪 🚮 🌖 📻 🆎 image/png, 📣 👈 👆 ➡ 🛠️ 💪 📨 🎻 🎚 (⏮️ 📻 🆎 application/json) ⚖️ 🇩🇴 🖼:

{* ../../docs_src/additional_responses/tutorial002.py hl[19:24,28] *}

/// note

👀 👈 👆 ✔️ 📨 🖼 ⚙️ FileResponse 🔗.

///

/// info

🚥 👆 ✔ 🎏 📻 🆎 🎯 👆 responses 🔢, FastAPI 🔜 🤔 📨 ✔️ 🎏 📻 🆎 👑 📨 🎓 (🔢 application/json).

✋️ 🚥 👆 ✔️ ✔ 🛃 📨 🎓 ⏮️ None 🚮 📻 🆎, FastAPI 🔜 ⚙️ application/json 🙆 🌖 📨 👈 ✔️ 👨‍💼 🏷.

///

🌀 ℹ

👆 💪 🌀 📨 ℹ ⚪️➡️ 💗 🥉, 🔌 response_model, status_code, & responses 🔢.

👆 💪 📣 response_model, ⚙️ 🔢 👔 📟 200 (⚖️ 🛃 1️⃣ 🚥 👆 💪), & ⤴️ 📣 🌖 ℹ 👈 🎏 📨 responses, 🔗 🗄 🔗.

FastAPI 🔜 🚧 🌖 ℹ ⚪️➡️ responses, & 🌀 ⚫️ ⏮️ 🎻 🔗 ⚪️➡️ 👆 🏷.

🖼, 👆 💪 📣 📨 ⏮️ 👔 📟 404 👈 ⚙️ Pydantic 🏷 & ✔️ 🛃 description.

& 📨 ⏮️ 👔 📟 200 👈 ⚙️ 👆 response_model, ✋️ 🔌 🛃 example:

{* ../../docs_src/additional_responses/tutorial003.py hl[20:31] *}

⚫️ 🔜 🌐 🌀 & 🔌 👆 🗄, & 🎦 🛠️ 🩺:

🌀 🔢 📨 & 🛃 🕐

👆 💪 💚 ✔️ 🔁 📨 👈 ✔ 📚 ➡ 🛠️, ✋️ 👆 💚 🌀 👫 ⏮️ 🛃 📨 💚 🔠 ➡ 🛠️.

📚 💼, 👆 💪 ⚙️ 🐍 ⚒ "🏗" dict ⏮️ **dict_to_unpack:

old_dict = {
    "old key": "old value",
    "second old key": "second old value",
}
new_dict = {**old_dict, "new key": "new value"}

📥, new_dict 🔜 🔌 🌐 🔑-💲 👫 ⚪️➡️ old_dict ➕ 🆕 🔑-💲 👫:

{
    "old key": "old value",
    "second old key": "second old value",
    "new key": "new value",
}

👆 💪 ⚙️ 👈 ⚒ 🏤-⚙️ 🔢 📨 👆 ➡ 🛠️ & 🌀 👫 ⏮️ 🌖 🛃 🕐.

🖼:

{* ../../docs_src/additional_responses/tutorial004.py hl[13:17,26] *}

🌖 ℹ 🔃 🗄 📨

👀 ⚫️❔ ⚫️❔ 👆 💪 🔌 📨, 👆 💪 ✅ 👉 📄 🗄 🔧:

• 🗄 📨 🎚, ⚫️ 🔌 Response Object.
• 🗄 📨 🎚, 👆 💪 🔌 🕳 ⚪️➡️ 👉 🔗 🔠 📨 🔘 👆 responses 🔢. ✅ description, headers, content (🔘 👉 👈 👆 📣 🎏 🔉 🆎 & 🎻 🔗), & links.