test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  475c74f8_bc3f_58de_6494_938cec2f58dc["test_openapi_schema()"]
  c4979cd9_80cd_7995_c6ff_bb63eb1455c8["test_security_api_key_header_optional.py"]
  475c74f8_bc3f_58de_6494_938cec2f58dc -->|defined in| c4979cd9_80cd_7995_c6ff_bb63eb1455c8
  style 475c74f8_bc3f_58de_6494_938cec2f58dc fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_security_api_key_header_optional.py lines 47–75

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": [{"APIKeyHeader": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"}
                }
            },
        }
    )