test_openapi_schema() — fastapi Function Reference

Architecture documentation for the test_openapi_schema() function in test_security_api_key_cookie_description.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  cc0a7335_df99_1085_50d8_6c6628a80e43["test_openapi_schema()"]
  a9be1828_2cf7_6bd9_32a1_88dbaf8e114c["test_security_api_key_cookie_description.py"]
  cc0a7335_df99_1085_50d8_6c6628a80e43 -->|defined in| a9be1828_2cf7_6bd9_32a1_88dbaf8e114c
  style cc0a7335_df99_1085_50d8_6c6628a80e43 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_security_api_key_cookie_description.py lines 41–75

def test_openapi_schema():
    client = TestClient(app)
    response = client.get("/openapi.json")
    assert response.status_code == 200, response.text
    assert response.json() == snapshot(
        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/users/me": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "summary": "Read Current User",
                        "operationId": "read_current_user_users_me_get",
                        "security": [{"APIKeyCookie": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "APIKeyCookie": {
                        "type": "apiKey",
                        "name": "key",
                        "in": "cookie",
                        "description": "An API Cookie Key",
                    }
                }
            },
        }
    )