test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  95cea79c_bf57_bf9c_601e_3796fac3076b["test_openapi_schema()"]
  66cc3715_e8ab_57ab_b56a_7a46fdf9b2d7["test_security_openid_connect_description.py"]
  95cea79c_bf57_bf9c_601e_3796fac3076b -->|defined in| 66cc3715_e8ab_57ab_b56a_7a46fdf9b2d7
  style 95cea79c_bf57_bf9c_601e_3796fac3076b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_security_openid_connect_description.py lines 50–82

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": [{"OpenIdConnect": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "OpenIdConnect": {
                        "type": "openIdConnect",
                        "openIdConnectUrl": "/openid",
                        "description": "OpenIdConnect security scheme",
                    }
                }
            },
        }
    )