Body

No overview available.

def Body(
    default: Any = Undefined,
    default_factory: Callable[[], Any] | None = _Unset,
    embed: bool | None = None,
    media_type: str = "application/json",
    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] | None = None,
    deprecated: deprecated | str | bool | None = None,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any] | None = None,
    extra: Any
) - > Any

Configures how a parameter should be processed as part of the request body. This function is used to define metadata and validation rules for request body parameters in web applications, influencing how data is extracted, validated, and documented in OpenAPI schemas.

Parameters

Name	Type	Description
default	Any = Undefined	The default value to be used if the parameter field is not explicitly set in the request body.
default_factory	`Callable[[], Any]	None` = _Unset
embed	`bool	None` = None
media_type	str = "application/json"	The media type of this parameter field. While it affects the generated OpenAPI documentation, it currently does not alter the parsing of the 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	A boolean indicating whether to include this parameter field in the generated OpenAPI schema.
json_schema_extra	`dict[str, Any]	None` = None
extra	Any	Additional fields used by the JSON Schema. This parameter is deprecated; use json_schema_extra instead.

Returns

Type	Description
Any	A configured parameter object that can be used in a function signature to define a request body field.