happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge e646e1e09f into 272204c0c7

This commit is contained in:
Vinícius Aguiar 2025-12-16 21:07:31 +00:00 committed by GitHub
parent 272204c0c7 e646e1e09f
commit 4c558335f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 165 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
fastapi/openapi/utils.py
View File

@ -367,11 +367,17 @@ def get_openapi_path(
) )
else: else:
response_schema = {} response_schema = {}
operation.setdefault("responses", {}).setdefault(
route_responses = {str(k): v for k, v in route.responses.items()}
if status_code not in route_responses or not route_responses.get(
status_code, {} status_code, {}
).setdefault("content", {}).setdefault(route_response_media_type, {})[ ).get("superimpose"):
"schema" operation.setdefault("responses", {}).setdefault(
] = response_schema status_code, {}
).setdefault("content", {}).setdefault(
route_response_media_type, {}
)["schema"] = response_schema
if route.responses: if route.responses:
operation_responses = operation.setdefault("responses", {}) operation_responses = operation.setdefault("responses", {})
for ( for (
@ -380,6 +386,7 @@ def get_openapi_path(
) in route.responses.items(): ) in route.responses.items():
process_response = additional_response.copy() process_response = additional_response.copy()
process_response.pop("model", None) process_response.pop("model", None)
process_response.pop("superimpose", None)
status_code_key = str(additional_status_code).upper() status_code_key = str(additional_status_code).upper()
if status_code_key == "DEFAULT": if status_code_key == "DEFAULT":
status_code_key = "default" status_code_key = "default"

154
tests/test_additional_responses_default_media_type.py Normal file
View File

@ -0,0 +1,154 @@
"""
This test is about the possibility of superimposing an additional response's media_type
over the default route's response class's media_type.
"""
from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel
from starlette.status import HTTP_200_OK, HTTP_500_INTERNAL_SERVER_ERROR
app = FastAPI()
client = TestClient(app)
class Error(BaseModel):
status: str
title: str
@app.get(
"/a",
responses={
HTTP_200_OK: {"superimpose": True, "content": {"text/event-stream": {}}},
HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error},
},
)
def a():
pass # pragma: no cover
@app.get(
"/b",
responses={
str(HTTP_200_OK): {"content": {"text/event-stream": {}}},
HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error},
},
)
def b():
pass # pragma: no cover
@app.get(
"/c",
responses={
HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error}
},
)
def c():
pass # pragma: no cover
@app.get("/d")
def d():
pass # pragma: no cover
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == {
"openapi": "3.1.0",
"info": {"title": "FastAPI", "version": "0.1.0"},
"paths": {
"/a": {
"get": {
"summary": "A",
"operationId": "a_a_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {"text/event-stream": {}},
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Error"}
}
},
},
},
}
},
"/b": {
"get": {
"summary": "B",
"operationId": "b_b_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {"schema": {}},
"text/event-stream": {},
},
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Error"}
}
},
},
},
}
},
"/c": {
"get": {
"summary": "C",
"operationId": "c_c_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Error"}
}
},
},
},
}
},
"/d": {
"get": {
"summary": "D",
"operationId": "d_d_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
}
},
}
},
},
"components": {
"schemas": {
"Error": {
"properties": {
"status": {"type": "string", "title": "Status"},
"title": {"type": "string", "title": "Title"},
},
"type": "object",
"required": ["status", "title"],
"title": "Error",
}
}
},
}