PathItem Class — fastapi Architecture

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

Class python FastAPI

Entity Profile

FastAPI→ PathItem Class — fastapi Architecture

Dependency Diagram

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

Relationship Graph

Source Code

fastapi/openapi/models.py lines 305–318

class PathItem(BaseModelWithConfig):
    ref: Optional[str] = Field(default=None, alias="$ref")
    summary: Optional[str] = None
    description: Optional[str] = None
    get: Optional[Operation] = None
    put: Optional[Operation] = None
    post: Optional[Operation] = None
    delete: Optional[Operation] = None
    options: Optional[Operation] = None
    head: Optional[Operation] = None
    patch: Optional[Operation] = None
    trace: Optional[Operation] = None
    servers: Optional[list[Server]] = None
    parameters: Optional[list[Union[Parameter, Reference]]] = None