test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  34ccf2a4_3ff0_ca03_375a_dbbadd0d5001["test_openapi_schema()"]
  8477b352_e74d_48b2_1d96_bf50d361b008["test_security_http_basic_realm_description.py"]
  34ccf2a4_3ff0_ca03_375a_dbbadd0d5001 -->|defined in| 8477b352_e74d_48b2_1d96_bf50d361b008
  style 34ccf2a4_3ff0_ca03_375a_dbbadd0d5001 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_security_http_basic_realm_description.py lines 52–84

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": [{"HTTPBasic": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "HTTPBasic": {
                        "type": "http",
                        "scheme": "basic",
                        "description": "HTTPBasic scheme",
                    }
                }
            },
        }
    )