Browse Source

Add variants for `additional_responses/tutorial004`

pull/14413/head
Yurii Motov 8 months ago
parent
commit
42e30173d3
  1. 2
      docs/en/docs/advanced/additional-responses.md
  2. 30
      docs_src/additional_responses/tutorial004_py310.py
  3. 25
      tests/test_tutorial/test_additional_responses/test_tutorial004.py

2
docs/en/docs/advanced/additional-responses.md

@ -237,7 +237,7 @@ You can use that technique to reuse some predefined responses in your *path oper
For example:
{* ../../docs_src/additional_responses/tutorial004.py hl[13:17,26] *}
{* ../../docs_src/additional_responses/tutorial004_py310.py hl[11:15,24] *}
## More information about OpenAPI responses { #more-information-about-openapi-responses }

30
docs_src/additional_responses/tutorial004_py310.py

@ -0,0 +1,30 @@
from fastapi import FastAPI
from fastapi.responses import FileResponse
from pydantic import BaseModel
class Item(BaseModel):
id: str
value: str
responses = {
404: {"description": "Item not found"},
302: {"description": "The item was moved"},
403: {"description": "Not enough privileges"},
}
app = FastAPI()
@app.get(
"/items/{item_id}",
response_model=Item,
responses={**responses, 200: {"content": {"image/png": {}}}},
)
async def read_item(item_id: str, img: bool | None = None):
if img:
return FileResponse("image.png", media_type="image/png")
else:
return {"id": "foo", "value": "there goes my hero"}

25
tests/test_tutorial/test_additional_responses/test_tutorial004.py

@ -1,21 +1,36 @@
import importlib
import os
import shutil
import pytest
from dirty_equals import IsDict
from fastapi.testclient import TestClient
from docs_src.additional_responses.tutorial004 import app
from tests.utils import needs_py310
client = TestClient(app)
@pytest.fixture(
name="client",
params=[
pytest.param("tutorial004"),
pytest.param("tutorial004_py310", marks=needs_py310),
],
)
def get_client(request: pytest.FixtureRequest):
mod = importlib.import_module(f"docs_src.additional_responses.{request.param}")
def test_path_operation():
client = TestClient(mod.app)
client.headers.clear()
return client
def test_path_operation(client: TestClient):
response = client.get("/items/foo")
assert response.status_code == 200, response.text
assert response.json() == {"id": "foo", "value": "there goes my hero"}
def test_path_operation_img():
def test_path_operation_img(client: TestClient):
shutil.copy("./docs/en/docs/img/favicon.png", "./image.png")
response = client.get("/items/foo?img=1")
assert response.status_code == 200, response.text
@ -24,7 +39,7 @@ def test_path_operation_img():
os.remove("./image.png")
def test_openapi_schema():
def test_openapi_schema(client: TestClient):
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == {

Loading…
Cancel
Save