Skip to main content

Path

This class represents a path parameter, inheriting from Param. It is specifically designed for defining parameters that are part of the URL path. It supports various validation and documentation features through its constructor arguments, such as title, description, and schema examples.

Attributes​

AttributeTypeDescription
in_ParamTypes.pathThis attribute stores the parameter type as a path parameter, indicating how the parameter's value is extracted from the request URL.

Constructor​

Signature​

def Path(
    default: Any = ...,
    default_factory: Callable[[], Any]| None = _Unset,
    annotation: Any | None = null,
    alias: str | None = null,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = null,
    serialization_alias: str | None = null,
    title: str | None = null,
    description: str | None = null,
    gt: float | None = null,
    ge: float | None = null,
    lt: float | None = null,
    le: float | None = null,
    min_length: int | None = null,
    max_length: int | None = null,
    pattern: str | None = null,
    regex: Annotated[str | None, deprecated("Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead.")] = null,
    discriminator: str | None = null,
    strict: bool | None = _Unset,
    multiple_of: float | None = _Unset,
    allow_inf_nan: bool | None = _Unset,
    max_digits: int | None = _Unset,
    decimal_places: int | None = _Unset,
    examples: list[Any]| None = null,
    example: Annotated[Any | None, deprecated("Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.")] = _Unset,
    openapi_examples: dict[str, [Example](../openapi/models/example.md?sid=fastapi_openapi_models_example)]| None = null,
    deprecated: deprecated | str | bool | None = null,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any]| None = null,
    extra: Any = null
) - > null

Parameters​

NameTypeDescription
defaultAny = ...The default value for the parameter. Path parameters cannot have a default value.
default_factory`Callable[[], Any]None` = _Unset
annotation`AnyNone` = null
alias`strNone` = null
alias_priority`intNone` = _Unset
validation_alias`strAliasPath
serialization_alias`strNone` = null
title`strNone` = null
description`strNone` = null
gt`floatNone` = null
ge`floatNone` = null
lt`floatNone` = null
le`floatNone` = null
min_length`intNone` = null
max_length`intNone` = null
pattern`strNone` = null
regex`Annotated[strNone, deprecated("Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.")]` = null
discriminator`strNone` = null
strict`boolNone` = _Unset
multiple_of`floatNone` = _Unset
allow_inf_nan`boolNone` = _Unset
max_digits`intNone` = _Unset
decimal_places`intNone` = _Unset
examples`list[Any]None` = null
example`Annotated[AnyNone, deprecated("Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.")]` = _Unset
openapi_examples`dict[str, Example]None` = null
deprecated`deprecatedstr
include_in_schemabool = TrueWhether to include the parameter in the OpenAPI schema.
json_schema_extra`dict[str, Any]None` = null
extraAny = nullAdditional keyword arguments.

Signature​

def Path(
    default: Any = ...,
    default_factory: Callable[[], Any]| None = _Unset,
    annotation: Any | None = null,
    alias: str | None = null,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = null,
    serialization_alias: str | None = null,
    title: str | None = null,
    description: str | None = null,
    gt: float | None = null,
    ge: float | None = null,
    lt: float | None = null,
    le: float | None = null,
    min_length: int | None = null,
    max_length: int | None = null,
    pattern: str | None = null,
    regex: Annotated[str | None, deprecated("Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead.")] = null,
    discriminator: str | None = null,
    strict: bool | None = _Unset,
    multiple_of: float | None = _Unset,
    allow_inf_nan: bool | None = _Unset,
    max_digits: int | None = _Unset,
    decimal_places: int | None = _Unset,
    examples: list[Any]| None = null,
    example: Annotated[Any | None, deprecated("Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.")] = _Unset,
    openapi_examples: dict[str, [Example](../openapi/models/example.md?sid=fastapi_openapi_models_example)]| None = null,
    deprecated: deprecated | str | bool | None = null,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any]| None = null,
    extra: Any = null
) - > null

Parameters​

NameTypeDescription
defaultAny = ...The default value for the parameter. Path parameters are asserted not to have a default value.
default_factory`Callable[[], Any]None` = _Unset
annotation`AnyNone` = null
alias`strNone` = null
alias_priority`intNone` = _Unset
validation_alias`strAliasPath
serialization_alias`strNone` = null
title`strNone` = null
description`strNone` = null
gt`floatNone` = null
ge`floatNone` = null
lt`floatNone` = null
le`floatNone` = null
min_length`intNone` = null
max_length`intNone` = null
pattern`strNone` = null
regex`Annotated[strNone, deprecated("Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.")]` = null
discriminator`strNone` = null
strict`boolNone` = _Unset
multiple_of`floatNone` = _Unset
allow_inf_nan`boolNone` = _Unset
max_digits`intNone` = _Unset
decimal_places`intNone` = _Unset
examples`list[Any]None` = null
example`Annotated[AnyNone, deprecated("Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.")]` = _Unset
openapi_examples`dict[str, Example]None` = null
deprecated`deprecatedstr
include_in_schemabool = TrueIf False, the parameter will not be included in the generated OpenAPI schema.
json_schema_extra`dict[str, Any]None` = null
extraAny = nullAdditional keyword arguments that will be passed to the base Param constructor.