test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  fc0ffc0d_f8f1_7d1f_61f5_913212978e69["test_openapi_schema()"]
  0fe3f8ea_3be3_8a13_6ed5_140ccdf0b591["test_starlette_exception.py"]
  fc0ffc0d_f8f1_7d1f_61f5_913212978e69 -->|defined in| 0fe3f8ea_3be3_8a13_6ed5_140ccdf0b591
  style fc0ffc0d_f8f1_7d1f_61f5_913212978e69 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_starlette_exception.py lines 80–209

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": {
                "/http-no-body-statuscode-exception": {
                    "get": {
                        "operationId": "no_body_status_code_exception_http_no_body_statuscode_exception_get",
                        "responses": {
                            "200": {
                                "content": {"application/json": {"schema": {}}},
                                "description": "Successful Response",
                            }
                        },
                        "summary": "No Body Status Code Exception",
                    }
                },
                "/http-no-body-statuscode-with-detail-exception": {
                    "get": {
                        "operationId": "no_body_status_code_with_detail_exception_http_no_body_statuscode_with_detail_exception_get",
                        "responses": {
                            "200": {
                                "content": {"application/json": {"schema": {}}},
                                "description": "Successful Response",
                            }
                        },
                        "summary": "No Body Status Code With Detail Exception",
                    }
                },
                "/items/{item_id}": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            },
                            "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",
                            }
                        ],
                    }
                },
                "/starlette-items/{item_id}": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            },
                            "422": {
                                "description": "Validation Error",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "$ref": "#/components/schemas/HTTPValidationError"
                                        }
                                    }
                                },
                            },
                        },
                        "summary": "Read Starlette Item",