test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  49a1b5c2_e021_ac66_7435_fc4cfa3b5b18["test_openapi_schema()"]
  d7907aed_d618_3645_b625_89f163a91978["test_security_http_base_description.py"]
  49a1b5c2_e021_ac66_7435_fc4cfa3b5b18 -->|defined in| d7907aed_d618_3645_b625_89f163a91978
  style 49a1b5c2_e021_ac66_7435_fc4cfa3b5b18 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_security_http_base_description.py lines 32–64

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": [{"HTTPBase": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "HTTPBase": {
                        "type": "http",
                        "scheme": "Other",
                        "description": "Other Security Scheme",
                    }
                }
            },
        }
    )