Added tests for openapi responses.

Signed-off-by: Pavel Kirilin <win10@list.ru>

Author: s3rius

aiohttp_deps/swagger.py

@@ -98,8 +98,8 @@ def _insert_in_params(data: Dict[str, Any]) -> None:
             params[(data["name"], data["in"])] = data
             return
         element["required"] = element.get("required") or data.get("required")
-        element["allowEmptyValue"] = element.get("allowEmptyValue") and data.get(
-            "allowEmptyValue",
+        element["allowEmptyValue"] = bool(element.get("allowEmptyValue")) and bool(
+            data.get("allowEmptyValue"),
         )
         params[(data["name"], data["in"])] = element
 
@@ -317,10 +317,12 @@ def decorator(func: _T) -> _T:
         openapi = getattr(func, "__extra_openapi__", {})
         adapter: "pydantic.TypeAdapter[Any]" = pydantic.TypeAdapter(model)
         responses = openapi.get("responses", {})
-        responses[status] = {
-            "description": description,
-            "content": {content_type: {"schema": adapter.json_schema()}},
-        }
+        status_response = responses.get(status, {})
+        if not status_response:
+            status_response["description"] = description
+        status_response["content"] = status_response.get("content", {})
+        status_response["content"][content_type] = {"schema": adapter.json_schema()}
+        responses[status] = status_response
         openapi["responses"] = responses
         func.__extra_openapi__ = openapi  # type: ignore
         return func

tests/test_swagger.py

@@ -16,6 +16,7 @@
     extra_openapi,
     setup_swagger,
 )
+from aiohttp_deps.swagger import openapi_response
 from tests.conftest import ClientGenerator
 
 
@@ -470,3 +471,94 @@ async def post():
 
     handler_info = resp_json["paths"]["/a"]["post"]
     assert handler_info["post_info"] == "wow"
+
+
+@pytest.mark.anyio
+async def test_merge_headers(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+) -> None:
+    OPENAPI_URL = "/my_api_def.json"
+    my_app.on_startup.append(setup_swagger(schema_url=OPENAPI_URL))
+
+    async def my_handler(
+        my_var: Optional[str] = Depends(Header(alias="head")),
+        my_var2: Optional[str] = Depends(Header(alias="head")),
+        my_var3: str = Depends(Header(alias="head")),
+    ):
+        """Nothing."""
+
+    my_app.router.add_get("/a", my_handler)
+
+    client = await aiohttp_client(my_app)
+    resp = await client.get(OPENAPI_URL)
+    assert resp.status == 200
+    resp_json = await resp.json()
+    params = resp_json["paths"]["/a"]["get"]["parameters"]
+    print(params)
+    assert len(params) == 1
+    assert params[0]["name"] == "Head"
+    assert params[0]["required"]
+    assert not params[0]["allowEmptyValue"]
+
+
+@pytest.mark.anyio
+async def test_custom_responses(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+) -> None:
+    OPENAPI_URL = "/my_api_def.json"
+    my_app.on_startup.append(setup_swagger(schema_url=OPENAPI_URL))
+
+    class RespModel(BaseModel):
+        name: str
+        age: int
+
+    class UnauthModel(BaseModel):
+        why: str
+
+    @openapi_response(200, RespModel)
+    @openapi_response(401, UnauthModel)
+    async def my_handler():
+        """Nothing."""
+
+    my_app.router.add_get("/a", my_handler)
+
+    client = await aiohttp_client(my_app)
+    resp = await client.get(OPENAPI_URL)
+    resp_json = await resp.json()
+    route_info = resp_json["paths"]["/a"]["get"]
+    assert "401" in route_info["responses"]
+    assert "200" in route_info["responses"]
+    assert "schema" in route_info["responses"]["200"]["content"]["application/json"]
+    assert "schema" in route_info["responses"]["401"]["content"]["application/json"]
+
+
+@pytest.mark.anyio
+async def test_custom_responses_multi_content_type(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+) -> None:
+    OPENAPI_URL = "/my_api_def.json"
+    my_app.on_startup.append(setup_swagger(schema_url=OPENAPI_URL))
+
+    class First(BaseModel):
+        name: str
+
+    class Second(BaseModel):
+        age: int
+
+    @openapi_response(200, First, content_type="application/json")
+    @openapi_response(200, Second, content_type="application/xml")
+    async def my_handler():
+        """Nothing."""
+
+    my_app.router.add_get("/a", my_handler)
+
+    client = await aiohttp_client(my_app)
+    resp = await client.get(OPENAPI_URL)
+    resp_json = await resp.json()
+    route_info = resp_json["paths"]["/a"]["get"]
+    assert "200" in route_info["responses"]
+    assert "application/json" in route_info["responses"]["200"]["content"]
+    assert "application/xml" in route_info["responses"]["200"]["content"]