test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  691fb235_c335_e42e_c7d5_52829c6fbfee["test_openapi_schema()"]
  3f822767_404f_eb0a_a6af_a3faaeaf55d7["test_duplicate_models_openapi.py"]
  691fb235_c335_e42e_c7d5_52829c6fbfee -->|defined in| 3f822767_404f_eb0a_a6af_a3faaeaf55d7
  style 691fb235_c335_e42e_c7d5_52829c6fbfee fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_duplicate_models_openapi.py lines 36–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": {
                "/": {
                    "get": {
                        "summary": "F",
                        "operationId": "f__get",
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "$ref": "#/components/schemas/Model3"
                                        }
                                    }
                                },
                            }
                        },
                    }
                }
            },
            "components": {
                "schemas": {
                    "Model": {"title": "Model", "type": "object", "properties": {}},
                    "Model2": {
                        "title": "Model2",
                        "required": ["a"],
                        "type": "object",
                        "properties": {"a": {"$ref": "#/components/schemas/Model"}},
                    },
                    "Model3": {
                        "title": "Model3",
                        "required": ["c", "d"],
                        "type": "object",
                        "properties": {
                            "c": {"$ref": "#/components/schemas/Model"},
                            "d": {"$ref": "#/components/schemas/Model2"},
                        },
                    },
                }
            },
        }
    )