test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  63bd7aa6_ad3b_04e0_190c_20d15d48256e["test_openapi_schema()"]
  71b3b53e_20c8_5182_1be5_373d7169f69e["test_tutorial003.py"]
  63bd7aa6_ad3b_04e0_190c_20d15d48256e -->|defined in| 71b3b53e_20c8_5182_1be5_373d7169f69e
  style 63bd7aa6_ad3b_04e0_190c_20d15d48256e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_tutorial/test_extra_models/test_tutorial003.py lines 43–159

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/{item_id}": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "title": "Response Read Item Items  Item Id  Get",
                                            "anyOf": [
                                                {
                                                    "$ref": "#/components/schemas/PlaneItem"
                                                },
                                                {
                                                    "$ref": "#/components/schemas/CarItem"
                                                },
                                            ],
                                        }
                                    }
                                },
                            },
                            "422": {
                                "description": "Validation Error",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "$ref": "#/components/schemas/HTTPValidationError"
                                        }
                                    }
                                },
                            },
                        },
                        "summary": "Read Item",
                        "operationId": "read_item_items__item_id__get",
                        "parameters": [
                            {
                                "required": True,
                                "schema": {"title": "Item Id", "type": "string"},
                                "name": "item_id",
                                "in": "path",
                            }
                        ],
                    }
                }
            },
            "components": {
                "schemas": {
                    "PlaneItem": {
                        "title": "PlaneItem",
                        "required": ["description", "size"],
                        "type": "object",
                        "properties": {
                            "description": {"title": "Description", "type": "string"},
                            "type": {
                                "title": "Type",
                                "type": "string",
                                "default": "plane",
                            },
                            "size": {"title": "Size", "type": "integer"},
                        },
                    },
                    "CarItem": {
                        "title": "CarItem",
                        "required": ["description"],
                        "type": "object",
                        "properties": {
                            "description": {"title": "Description", "type": "string"},
                            "type": {
                                "title": "Type",
                                "type": "string",
                                "default": "car",
                            },
                        },