Path

This class represents a path parameter in an API endpoint and is used to define metadata and validation rules for values extracted from the URL path. It supports a wide range of constraints, including numeric limits, string patterns, and OpenAPI-specific metadata like examples and deprecation status. Notably, path parameters are required by design and do not support default values.

Attributes

Attribute	Type	Description
in_	[ParamTypes](paramtypes.md?sid=fastapi_params_paramtypes) = ParamTypes.path	The location of the parameter in the request, which is fixed to 'path' for this class.

---

Constructor

Signature

def Path(
    default: Any = ...,
    default_factory: Callable[[], Any]| None = _Unset,
    annotation: Any | None = None,
    alias: str | None = None,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = None,
    serialization_alias: str | None = None,
    title: str | None = None,
    description: str | None = None,
    gt: float | None = None,
    ge: float | None = None,
    lt: float | None = None,
    le: float | None = None,
    min_length: int | None = None,
    max_length: int | None = None,
    pattern: str | None = None,
    regex: str | None = None,
    discriminator: str | None = None,
    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 = None,
    example: Any | None = _Unset,
    openapi_examples: dict[str, [Example](../openapi/models/example.md?sid=fastapi_openapi_models_example)]| None = None,
    deprecated: deprecated | str | bool | None = None,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any]| None = None,
    **extra: Any
)

Parameters

Name	Type	Description
default	Any = ...	The default value for the parameter. Must be ellipsis (...) as path parameters are required.
default_factory	`Callable[[], Any]	None` = _Unset
annotation	`Any	None` = None
alias	`str	None` = None
alias_priority	`int	None` = _Unset
validation_alias	`str	AliasPath
serialization_alias	`str	None` = None
title	`str	None` = None
description	`str	None` = None
gt	`float	None` = None
ge	`float	None` = None
lt	`float	None` = None
le	`float	None` = None
min_length	`int	None` = None
max_length	`int	None` = None
pattern	`str	None` = None
regex	`str	None` = None
discriminator	`str	None` = None
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` = None
example	`Any	None` = _Unset
openapi_examples	`dict[str, Example]	None` = None
deprecated	`deprecated	str
include_in_schema	bool = True	Whether to include this parameter in the OpenAPI schema.
json_schema_extra	`dict[str, Any]	None` = None
**extra	Any	Additional keyword arguments.

---

Signature

def Path(
    default: Any = ...,
    default_factory: Callable[[], Any]| None = _Unset,
    annotation: Any | None = None,
    alias: str | None = None,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = None,
    serialization_alias: str | None = None,
    title: str | None = None,
    description: str | None = None,
    gt: float | None = None,
    ge: float | None = None,
    lt: float | None = None,
    le: float | None = None,
    min_length: int | None = None,
    max_length: int | None = None,
    pattern: str | None = None,
    regex: str | None = None,
    discriminator: str | None = None,
    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 = None,
    example: Any | None = _Unset,
    openapi_examples: dict[str, [Example](../openapi/models/example.md?sid=fastapi_openapi_models_example)]| None = None,
    deprecated: deprecated | str | bool | None = None,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any]| None = None,
    extra: Any = null
) - > null

Parameters

Name	Type	Description
default	Any = ...	The default value for the parameter; must be Ellipsis (...) as path parameters are required by definition.
default_factory	`Callable[[], Any]	None` = _Unset
annotation	`Any	None` = None
alias	`str	None` = None
alias_priority	`int	None` = _Unset
validation_alias	`str	AliasPath
serialization_alias	`str	None` = None
title	`str	None` = None
description	`str	None` = None
gt	`float	None` = None
ge	`float	None` = None
lt	`float	None` = None
le	`float	None` = None
min_length	`int	None` = None
max_length	`int	None` = None
pattern	`str	None` = None
regex	`str	None` = None
discriminator	`str	None` = None
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` = None
example	`Any	None` = _Unset
openapi_examples	`dict[str, Example]	None` = None
deprecated	`deprecated	str
include_in_schema	bool = True	Whether to include this parameter in the generated OpenAPI specification.
json_schema_extra	`dict[str, Any]	None` = None
extra	Any = null	Additional keyword arguments passed to the underlying Pydantic Field.

---