Components Class — fastapi Architecture

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

Class python FastAPI

Entity Profile

FastAPI→ Components Class — fastapi Architecture

Dependency Diagram

graph TD
  7cb761c2_5893_258c_f220_8b3d5be9ea85["Components"]
  6f158f64_db73_3529_caa7_fbf9276f5bed["BaseModelWithConfig"]
  7cb761c2_5893_258c_f220_8b3d5be9ea85 -->|extends| 6f158f64_db73_3529_caa7_fbf9276f5bed
  7f688779_6b22_3c15_6514_97dec91c3c30["models.py"]
  7cb761c2_5893_258c_f220_8b3d5be9ea85 -->|defined in| 7f688779_6b22_3c15_6514_97dec91c3c30

Relationship Graph

Source Code

fastapi/openapi/models.py lines 399–410

class Components(BaseModelWithConfig):
    schemas: Optional[dict[str, Union[Schema, Reference]]] = None
    responses: Optional[dict[str, Union[Response, Reference]]] = None
    parameters: Optional[dict[str, Union[Parameter, Reference]]] = None
    examples: Optional[dict[str, Union[Example, Reference]]] = None
    requestBodies: Optional[dict[str, Union[RequestBody, Reference]]] = None
    headers: Optional[dict[str, Union[Header, Reference]]] = None
    securitySchemes: Optional[dict[str, Union[SecurityScheme, Reference]]] = None
    links: Optional[dict[str, Union[Link, Reference]]] = None
    # Using Any for Specification Extensions
    callbacks: Optional[dict[str, Union[dict[str, PathItem], Reference, Any]]] = None
    pathItems: Optional[dict[str, Union[PathItem, Reference]]] = None