OpenAPI Class — fastapi Architecture

Architecture documentation for the OpenAPI class in models.py from the fastapi codebase.

Class python FastAPI

Entity Profile

FastAPI→ OpenAPI Class — fastapi Architecture

Dependency Diagram

graph TD
  5c202964_409b_55c8_48a8_a006784b351b["OpenAPI"]
  6f158f64_db73_3529_caa7_fbf9276f5bed["BaseModelWithConfig"]
  5c202964_409b_55c8_48a8_a006784b351b -->|extends| 6f158f64_db73_3529_caa7_fbf9276f5bed
  7f688779_6b22_3c15_6514_97dec91c3c30["models.py"]
  5c202964_409b_55c8_48a8_a006784b351b -->|defined in| 7f688779_6b22_3c15_6514_97dec91c3c30

Relationship Graph

Source Code

fastapi/openapi/models.py lines 419–430

class OpenAPI(BaseModelWithConfig):
    openapi: str
    info: Info
    jsonSchemaDialect: Optional[str] = None
    servers: Optional[list[Server]] = None
    # Using Any for Specification Extensions
    paths: Optional[dict[str, Union[PathItem, Any]]] = None
    webhooks: Optional[dict[str, Union[PathItem, Reference]]] = None
    components: Optional[Components] = None
    security: Optional[list[dict[str, list[str]]]] = None
    tags: Optional[list[Tag]] = None
    externalDocs: Optional[ExternalDocumentation] = None