test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  3aafb9bb_7cfb_15bb_b506_bf84361aaf4c["test_openapi_schema()"]
  39c373df_3dc0_2171_45d6_ce7be20b1ed3["test_security_api_key_query.py"]
  3aafb9bb_7cfb_15bb_b506_bf84361aaf4c -->|defined in| 39c373df_3dc0_2171_45d6_ce7be20b1ed3
  style 3aafb9bb_7cfb_15bb_b506_bf84361aaf4c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_security_api_key_query.py lines 42–70

def test_openapi_schema():
    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": [{"APIKeyQuery": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"}
                }
            },
        }
    )