Skip to main content

Components

This class holds a set of reusable objects for different aspects of an OpenAPI specification, such as schemas, responses, and parameters. It provides a centralized container for defining components that can be referenced throughout the API definition to ensure consistency and reduce redundancy. The class supports various OpenAPI elements including security schemes, request bodies, and specification extensions.

Attributes​

AttributeTypeDescription
schemas`dict[str, SchemaReference]
responses`dict[str, ResponseReference]
parameters`dict[str, ParameterReference]
examples`dict[str, ExampleReference]
requestBodies`dict[str, RequestBodyReference]
headers`dict[str, HeaderReference]
securitySchemes`dict[str, SecuritySchemeReference]
links`dict[str, LinkReference]
callbacks`dict[str, dict[str, PathItem]Reference
pathItems`dict[str, PathItemReference]

Constructor​

Signature​

def Components(
    schemas: dict[str, Schema | Reference]| None = None,
    responses: dict[str, Response | Reference]| None = None,
    parameters: dict[str, Parameter | Reference]| None = None,
    examples: dict[str, Example | Reference]| None = None,
    requestBodies: dict[str, RequestBody | Reference]| None = None,
    headers: dict[str, Header | Reference]| None = None,
    securitySchemes: dict[str, SecurityScheme | Reference]| None = None,
    links: dict[str, Link | Reference]| None = None,
    callbacks: dict[str, dict[str, [PathItem](pathitem.md?sid=fastapi_openapi_models_pathitem)]| Reference | Any]| None = None,
    pathItems: dict[str, PathItem | Reference]| None = None
) - > null

Parameters​

NameTypeDescription
schemas`dict[str, SchemaReference]
responses`dict[str, ResponseReference]
parameters`dict[str, ParameterReference]
examples`dict[str, ExampleReference]
requestBodies`dict[str, RequestBodyReference]
headers`dict[str, HeaderReference]
securitySchemes`dict[str, SecuritySchemeReference]
links`dict[str, LinkReference]
callbacks`dict[str, dict[str, PathItem]Reference
pathItems`dict[str, PathItemReference]