test_openapi_schema() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ test_openapi_schema() — fastapi Function Reference

Dependency Diagram

graph TD
  4c61ebc1_5d50_6b52_4c9c_cb625a29d876["test_openapi_schema()"]
  6f61443f_4f30_7c16_6a46_97ea966282f8["test_tutorial002.py"]
  4c61ebc1_5d50_6b52_4c9c_cb625a29d876 -->|defined in| 6f61443f_4f30_7c16_6a46_97ea966282f8
  style 4c61ebc1_5d50_6b52_4c9c_cb625a29d876 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_tutorial/test_security/test_tutorial002.py lines 43–74

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": {
                "/users/me": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "summary": "Read Users Me",
                        "operationId": "read_users_me_users_me_get",
                        "security": [{"OAuth2PasswordBearer": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "OAuth2PasswordBearer": {
                        "type": "oauth2",
                        "flows": {"password": {"scopes": {}, "tokenUrl": "token"}},
                    }
                },
            },
        }
    )