Form

This class defines a form field in an API request body, defaulting to the application/x-www-form-urlencoded media type. It provides extensive support for data validation, metadata annotation, and OpenAPI schema customization. As a subclass of Body, it allows for fine-grained control over aliases, constraints, and deprecation status for individual form parameters.

Attributes

Attribute	Type	Description
media_type	`string` = "application/x-www-form-urlencoded"	The media type used to encode the form data, defaulting to application/x-www-form-urlencoded.
include_in_schema	`boolean` = true	Whether to include this form field in the generated OpenAPI schema.

Constructor

Signature

def Form(
    default: Any = Undefined,
    default_factory: Callable[[], Any]| None = _Unset,
    annotation: Any | None = None,
    media_type: str = application/x-www-form-urlencoded,
    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

Parameters

Name	Type	Description
default	`Any` = Undefined	The default value for the form field.
default_factory	`Callable[[], Any]	None` = _Unset
annotation	`Any	None` = None
media_type	`str` = application/x-www-form-urlencoded	The media type for the form data.
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 field in the OpenAPI schema.
json_schema_extra	`dict[str, Any]	None` = None
**extra	`Any`	Additional keyword arguments.

Signature

def Form(
    default: Any = Undefined,
    default_factory: Callable[[], Any]| None = _Unset,
    annotation: Any | None = None,
    media_type: str = application/x-www-form-urlencoded,
    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
) - > null

Parameters

Name	Type	Description
default	`Any` = Undefined	The default value for the form field if none is provided in the request.
default_factory	`Callable[[], Any]	None` = _Unset
annotation	`Any	None` = None
media_type	`str` = application/x-www-form-urlencoded	The media type used to parse the request body, defaulting to standard form encoding.
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 field in the generated OpenAPI documentation.
json_schema_extra	`dict[str, Any]	None` = None

Attributes​

Constructor​

Signature​

Parameters​

Signature​

Parameters​

Attributes

Constructor

Signature

Parameters

Signature

Parameters