test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  79e84a14_2e4e_151b_5f2c_e0bc980fc8af["test_openapi_schema()"]
  58266310_4370_06bd_d15e_428d43dd0af1["test_tutorial012.py"]
  79e84a14_2e4e_151b_5f2c_e0bc980fc8af -->|defined in| 58266310_4370_06bd_d15e_428d43dd0af1
  style 79e84a14_2e4e_151b_5f2c_e0bc980fc8af fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_tutorial/test_dependencies/test_tutorial012.py lines 116–233

def test_openapi_schema(client: TestClient):
    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": {
                "/items/": {
                    "get": {
                        "summary": "Read Items",
                        "operationId": "read_items_items__get",
                        "parameters": [
                            {
                                "required": True,
                                "schema": {"title": "X-Token", "type": "string"},
                                "name": "x-token",
                                "in": "header",
                            },
                            {
                                "required": True,
                                "schema": {"title": "X-Key", "type": "string"},
                                "name": "x-key",
                                "in": "header",
                            },
                        ],
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            },
                            "422": {
                                "description": "Validation Error",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "$ref": "#/components/schemas/HTTPValidationError"
                                        }
                                    }
                                },
                            },
                        },
                    }
                },
                "/users/": {
                    "get": {
                        "summary": "Read Users",
                        "operationId": "read_users_users__get",
                        "parameters": [
                            {
                                "required": True,
                                "schema": {"title": "X-Token", "type": "string"},
                                "name": "x-token",
                                "in": "header",
                            },
                            {
                                "required": True,
                                "schema": {"title": "X-Key", "type": "string"},
                                "name": "x-key",
                                "in": "header",
                            },
                        ],
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            },
                            "422": {
                                "description": "Validation Error",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "$ref": "#/components/schemas/HTTPValidationError"
                                        }
                                    }
                                },
                            },
                        },
                    }
                },
            },