Request Parameters
Here’s the reference information for the request parameters.
These are the special functions that you can put in path operation function parameters or dependency functions with Annotated to get data from the request.
It includes:
Query()Path()Body()Cookie()Header()Form()File()
You can import them all directly from fastapi:
from fastapi import Body, Cookie, File, Form, Header, Path, Query
fastapi.Query
Query( default=Undefined, *, default_factory=_Unset, alias=None, alias_priority=_Unset, validation_alias=None, serialization_alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, regex=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, example=_Unset, openapi_examples=None, deprecated=None, include_in_schema=True, json_schema_extra=None, **extra)
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
| def Query( # noqa: N802 default: Annotated[ Any, Doc( “”” Default value if the parameter field is not set. “”” ), ] = Undefined, , default_factory: Annotated[ Union[Callable[[], Any], None], Doc( “”” A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. “”” ), ] = _Unset, alias: Annotated[ Optional[str], Doc( “”” An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. “”” ), ] = None, alias_priority: Annotated[ Union[int, None], Doc( “”” Priority of the alias. This affects whether an alias generator is used. “”” ), ] = _Unset, # TODO: update when deprecating Pydantic v1, import these types # validation_alias: str | AliasPath | AliasChoices | None validation_alias: Annotated[ Union[str, None], Doc( “”” ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. “”” ), ] = None, serialization_alias: Annotated[ Union[str, None], Doc( “”” ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. “”” ), ] = None, title: Annotated[ Optional[str], Doc( “”” Human-readable title. “”” ), ] = None, description: Annotated[ Optional[str], Doc( “”” Human-readable description. “”” ), ] = None, gt: Annotated[ Optional[float], Doc( “”” Greater than. If set, value must be greater than this. Only applicable to numbers. “”” ), ] = None, ge: Annotated[ Optional[float], Doc( “”” Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. “”” ), ] = None, lt: Annotated[ Optional[float], Doc( “”” Less than. If set, value must be less than this. Only applicable to numbers. “”” ), ] = None, le: Annotated[ Optional[float], Doc( “”” Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. “”” ), ] = None, min_length: Annotated[ Optional[int], Doc( “”” Minimum length for strings. “”” ), ] = None, max_length: Annotated[ Optional[int], Doc( “”” Maximum length for strings. “”” ), ] = None, pattern: Annotated[ Optional[str], Doc( “”” RegEx pattern for strings. “”” ), ] = None, regex: Annotated[ Optional[str], Doc( “”” RegEx pattern for strings. “”” ), deprecated( “Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.” ), ] = None, discriminator: Annotated[ Union[str, None], Doc( “”” Parameter field name for discriminating the type in a tagged union. “”” ), ] = None, strict: Annotated[ Union[bool, None], Doc( “”” If True, strict validation is applied to the field. “”” ), ] = _Unset, multiple_of: Annotated[ Union[float, None], Doc( “”” Value must be a multiple of this. Only applicable to numbers. “”” ), ] = _Unset, allow_inf_nan: Annotated[ Union[bool, None], Doc( “”” Allow inf, -inf, nan. Only applicable to numbers. “”” ), ] = _Unset, max_digits: Annotated[ Union[int, None], Doc( “”” Maximum number of allow digits for strings. “”” ), ] = _Unset, decimal_places: Annotated[ Union[int, None], Doc( “”” Maximum number of decimal places allowed for numbers. “”” ), ] = _Unset, examples: Annotated[ Optional[List[Any]], Doc( “”” Example values for this field. “”” ), ] = None, example: Annotated[ Optional[Any], deprecated( “Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “ “although still supported. Use examples instead.” ), ] = _Unset, openapi_examples: Annotated[ Optional[Dict[str, Example]], Doc( “”” OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. “”” ), ] = None, deprecated: Annotated[ Optional[bool], Doc( “”” Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). “”” ), ] = None, include_in_schema: Annotated[ bool, Doc( “”” To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). “”” ), ] = True, json_schema_extra: Annotated[ Union[Dict[str, Any], None], Doc( “”” Any additional JSON schema data. “”” ), ] = None, *extra: Annotated[ Any, Doc( “”” Include extra fields used by the JSON Schema. “”” ), deprecated( “”” The extra kwargs is deprecated. Use json_schema_extra instead. “”” ), ],) -> Any: return params.Query( default=default, default_factory=default_factory, alias=alias, alias_priority=alias_priority, validation_alias=validation_alias, serialization_alias=serialization_alias, title=title, description=description, gt=gt, ge=ge, lt=lt, le=le, min_length=min_length, max_length=max_length, pattern=pattern, regex=regex, discriminator=discriminator, strict=strict, multiple_of=multiple_of, allow_inf_nan=allow_inf_nan, max_digits=max_digits, decimal_places=decimal_places, example=example, examples=examples, openapi_examples=openapi_examples, deprecated=deprecated, include_in_schema=include_in_schema, json_schema_extra=json_schema_extra, extra, )
|
fastapi.Path
Path( default=..., *, default_factory=_Unset, alias=None, alias_priority=_Unset, validation_alias=None, serialization_alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, regex=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, example=_Unset, openapi_examples=None, deprecated=None, include_in_schema=True, json_schema_extra=None, **extra)
Declare a path parameter for a path operation.
Read more about it in the FastAPI docs for Path Parameters and Numeric Validations.
from typing import Annotatedfrom fastapi import FastAPI, Pathapp = FastAPI()@app.get("/items/{item_id}")async def read_items( item_id: Annotated[int, Path(title="The ID of the item to get")],): return {"item_id": item_id}
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Any DEFAULT: … |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
| def Path( # noqa: N802
default: Annotated[
Any,
Doc(
“””
Default value if the parameter field is not set.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = …,
,
default_factory: Annotated[
Union[Callable[[], Any], None],
Doc(
“””
A callable to generate the default value.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = _Unset,
alias: Annotated[
Optional[str],
Doc(
“””
An alternative name for the parameter field.
This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can’t use the name you want because it
is a Python reserved keyword or similar.
“””
),
] = None,
alias_priority: Annotated[
Union[int, None],
Doc(
“””
Priority of the alias. This affects whether an alias generator is used.
“””
),
] = _Unset,
# TODO: update when deprecating Pydantic v1, import these types
# validation_alias: str | AliasPath | AliasChoices | None
validation_alias: Annotated[
Union[str, None],
Doc(
“””
‘Whitelist’ validation step. The parameter field will be the single one
allowed by the alias or set of aliases defined.
“””
),
] = None,
serialization_alias: Annotated[
Union[str, None],
Doc(
“””
‘Blacklist’ validation step. The vanilla parameter field will be the
single one of the alias’ or set of aliases’ fields and all the other
fields will be ignored at serialization time.
“””
),
] = None,
title: Annotated[
Optional[str],
Doc(
“””
Human-readable title.
“””
),
] = None,
description: Annotated[
Optional[str],
Doc(
“””
Human-readable description.
“””
),
] = None,
gt: Annotated[
Optional[float],
Doc(
“””
Greater than. If set, value must be greater than this. Only applicable to
numbers.
“””
),
] = None,
ge: Annotated[
Optional[float],
Doc(
“””
Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers.
“””
),
] = None,
lt: Annotated[
Optional[float],
Doc(
“””
Less than. If set, value must be less than this. Only applicable to numbers.
“””
),
] = None,
le: Annotated[
Optional[float],
Doc(
“””
Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers.
“””
),
] = None,
min_length: Annotated[
Optional[int],
Doc(
“””
Minimum length for strings.
“””
),
] = None,
max_length: Annotated[
Optional[int],
Doc(
“””
Maximum length for strings.
“””
),
] = None,
pattern: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
] = None,
regex: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
deprecated(
“Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.”
),
] = None,
discriminator: Annotated[
Union[str, None],
Doc(
“””
Parameter field name for discriminating the type in a tagged union.
“””
),
] = None,
strict: Annotated[
Union[bool, None],
Doc(
“””
If True, strict validation is applied to the field.
“””
),
] = _Unset,
multiple_of: Annotated[
Union[float, None],
Doc(
“””
Value must be a multiple of this. Only applicable to numbers.
“””
),
] = _Unset,
allow_inf_nan: Annotated[
Union[bool, None],
Doc(
“””
Allow inf, -inf, nan. Only applicable to numbers.
“””
),
] = _Unset,
max_digits: Annotated[
Union[int, None],
Doc(
“””
Maximum number of allow digits for strings.
“””
),
] = _Unset,
decimal_places: Annotated[
Union[int, None],
Doc(
“””
Maximum number of decimal places allowed for numbers.
“””
),
] = _Unset,
examples: Annotated[
Optional[List[Any]],
Doc(
“””
Example values for this field.
“””
),
] = None,
example: Annotated[
Optional[Any],
deprecated(
“Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “
“although still supported. Use examples instead.”
),
] = _Unset,
openapi_examples: Annotated[
Optional[Dict[str, Example]],
Doc(
“””
OpenAPI-specific examples.
It will be added to the generated OpenAPI (e.g. visible at /docs).
Swagger UI (that provides the /docs interface) has better support for the
OpenAPI-specific examples than the JSON Schema examples, that’s the main
use case for this.
Read more about it in the
FastAPI docs for Declare Request Example Data.
“””
),
] = None,
deprecated: Annotated[
Optional[bool],
Doc(
“””
Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at /docs).
“””
),
] = None,
include_in_schema: Annotated[
bool,
Doc(
“””
To include (or not) this parameter field in the generated OpenAPI.
You probably don’t need it, but it’s available.
This affects the generated OpenAPI (e.g. visible at /docs).
“””
),
] = True,
json_schema_extra: Annotated[
Union[Dict[str, Any], None],
Doc(
“””
Any additional JSON schema data.
“””
),
] = None,
**extra: Annotated[
Any,
Doc(
“””
Include extra fields used by the JSON Schema.
“””
),
deprecated(
“””
The extra kwargs is deprecated. Use json_schema_extra instead.
“””
),
],
) -> Any:
“””
Declare a path parameter for a path operation.
Read more about it in the
FastAPI docs for Path Parameters and Numeric Validations.
python</span>
<span> from typing import Annotated</span>
<span> from fastapi import FastAPI, Path</span>
<span> app = FastAPI()</span>
<span> @app.get("/items/{item_id}")</span>
<span> async def read_items(</span>
<span> item_id: Annotated[int, Path(title="The ID of the item to get")],</span>
<span> ):</span>
<span> return {"item_id": item_id}</span>
<span>
“””
return params.Path(
default=default,
default_factory=default_factory,
alias=alias,
alias_priority=alias_priority,
validation_alias=validation_alias,
serialization_alias=serialization_alias,
title=title,
description=description,
gt=gt,
ge=ge,
lt=lt,
le=le,
min_length=min_length,
max_length=max_length,
pattern=pattern,
regex=regex,
discriminator=discriminator,
strict=strict,
multiple_of=multiple_of,
allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
example=example,
examples=examples,
openapi_examples=openapi_examples,
deprecated=deprecated,
include_in_schema=include_in_schema,
json_schema_extra=json_schema_extra,
*extra,
)
|
fastapi.Body
Body(
default=Undefined,
*,
default_factory=_Unset,
embed=False,
media_type="application/json",
alias=None,
alias_priority=_Unset,
validation_alias=None,
serialization_alias=None,
title=None,
description=None,
gt=None,
ge=None,
lt=None,
le=None,
min_length=None,
max_length=None,
pattern=None,
regex=None,
discriminator=None,
strict=_Unset,
multiple_of=_Unset,
allow_inf_nan=_Unset,
max_digits=_Unset,
decimal_places=_Unset,
examples=None,
example=_Unset,
openapi_examples=None,
deprecated=None,
include_in_schema=True,
json_schema_extra=None,
**extra
)
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
embed | When embed is True, the parameter will be expected in a JSON body as a key instead of being the JSON body itself. This happens automatically when more than one Body parameter is declared. Read more about it in the FastAPI docs for Body - Multiple Parameters. TYPE: bool DEFAULT: False |
media_type | The media type of this parameter field. Changing it would affect the generated OpenAPI, but currently it doesn’t affect the parsing of the data. TYPE: str DEFAULT: ‘application/json’ |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
| def Body( # noqa: N802
default: Annotated[
Any,
Doc(
“””
Default value if the parameter field is not set.
“””
),
] = Undefined,
,
default_factory: Annotated[
Union[Callable[[], Any], None],
Doc(
“””
A callable to generate the default value.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = _Unset,
embed: Annotated[
bool,
Doc(
“””
When embed is True, the parameter will be expected in a JSON body as a
key instead of being the JSON body itself.
This happens automatically when more than one Body parameter is declared.
Read more about it in the
FastAPI docs for Body - Multiple Parameters.
“””
),
] = False,
media_type: Annotated[
str,
Doc(
“””
The media type of this parameter field. Changing it would affect the
generated OpenAPI, but currently it doesn’t affect the parsing of the data.
“””
),
] = “application/json”,
alias: Annotated[
Optional[str],
Doc(
“””
An alternative name for the parameter field.
This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can’t use the name you want because it
is a Python reserved keyword or similar.
“””
),
] = None,
alias_priority: Annotated[
Union[int, None],
Doc(
“””
Priority of the alias. This affects whether an alias generator is used.
“””
),
] = _Unset,
# TODO: update when deprecating Pydantic v1, import these types
# validation_alias: str | AliasPath | AliasChoices | None
validation_alias: Annotated[
Union[str, None],
Doc(
“””
‘Whitelist’ validation step. The parameter field will be the single one
allowed by the alias or set of aliases defined.
“””
),
] = None,
serialization_alias: Annotated[
Union[str, None],
Doc(
“””
‘Blacklist’ validation step. The vanilla parameter field will be the
single one of the alias’ or set of aliases’ fields and all the other
fields will be ignored at serialization time.
“””
),
] = None,
title: Annotated[
Optional[str],
Doc(
“””
Human-readable title.
“””
),
] = None,
description: Annotated[
Optional[str],
Doc(
“””
Human-readable description.
“””
),
] = None,
gt: Annotated[
Optional[float],
Doc(
“””
Greater than. If set, value must be greater than this. Only applicable to
numbers.
“””
),
] = None,
ge: Annotated[
Optional[float],
Doc(
“””
Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers.
“””
),
] = None,
lt: Annotated[
Optional[float],
Doc(
“””
Less than. If set, value must be less than this. Only applicable to numbers.
“””
),
] = None,
le: Annotated[
Optional[float],
Doc(
“””
Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers.
“””
),
] = None,
min_length: Annotated[
Optional[int],
Doc(
“””
Minimum length for strings.
“””
),
] = None,
max_length: Annotated[
Optional[int],
Doc(
“””
Maximum length for strings.
“””
),
] = None,
pattern: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
] = None,
regex: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
deprecated(
“Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.”
),
] = None,
discriminator: Annotated[
Union[str, None],
Doc(
“””
Parameter field name for discriminating the type in a tagged union.
“””
),
] = None,
strict: Annotated[
Union[bool, None],
Doc(
“””
If True, strict validation is applied to the field.
“””
),
] = _Unset,
multiple_of: Annotated[
Union[float, None],
Doc(
“””
Value must be a multiple of this. Only applicable to numbers.
“””
),
] = _Unset,
allow_inf_nan: Annotated[
Union[bool, None],
Doc(
“””
Allow inf, -inf, nan. Only applicable to numbers.
“””
),
] = _Unset,
max_digits: Annotated[
Union[int, None],
Doc(
“””
Maximum number of allow digits for strings.
“””
),
] = _Unset,
decimal_places: Annotated[
Union[int, None],
Doc(
“””
Maximum number of decimal places allowed for numbers.
“””
),
] = _Unset,
examples: Annotated[
Optional[List[Any]],
Doc(
“””
Example values for this field.
“””
),
] = None,
example: Annotated[
Optional[Any],
deprecated(
“Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “
“although still supported. Use examples instead.”
),
] = _Unset,
openapi_examples: Annotated[
Optional[Dict[str, Example]],
Doc(
“””
OpenAPI-specific examples.
It will be added to the generated OpenAPI (e.g. visible at /docs).
Swagger UI (that provides the /docs interface) has better support for the
OpenAPI-specific examples than the JSON Schema examples, that’s the main
use case for this.
Read more about it in the
FastAPI docs for Declare Request Example Data.
“””
),
] = None,
deprecated: Annotated[
Optional[bool],
Doc(
“””
Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at /docs).
“””
),
] = None,
include_in_schema: Annotated[
bool,
Doc(
“””
To include (or not) this parameter field in the generated OpenAPI.
You probably don’t need it, but it’s available.
This affects the generated OpenAPI (e.g. visible at /docs).
“””
),
] = True,
json_schema_extra: Annotated[
Union[Dict[str, Any], None],
Doc(
“””
Any additional JSON schema data.
“””
),
] = None,
*extra: Annotated[
Any,
Doc(
“””
Include extra fields used by the JSON Schema.
“””
),
deprecated(
“””
The extra kwargs is deprecated. Use json_schema_extra instead.
“””
),
],
) -> Any:
return params.Body(
default=default,
default_factory=default_factory,
embed=embed,
media_type=media_type,
alias=alias,
alias_priority=alias_priority,
validation_alias=validation_alias,
serialization_alias=serialization_alias,
title=title,
description=description,
gt=gt,
ge=ge,
lt=lt,
le=le,
min_length=min_length,
max_length=max_length,
pattern=pattern,
regex=regex,
discriminator=discriminator,
strict=strict,
multiple_of=multiple_of,
allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
example=example,
examples=examples,
openapi_examples=openapi_examples,
deprecated=deprecated,
include_in_schema=include_in_schema,
json_schema_extra=json_schema_extra,
extra,
)
|
fastapi.Cookie
Cookie(
default=Undefined,
*,
default_factory=_Unset,
alias=None,
alias_priority=_Unset,
validation_alias=None,
serialization_alias=None,
title=None,
description=None,
gt=None,
ge=None,
lt=None,
le=None,
min_length=None,
max_length=None,
pattern=None,
regex=None,
discriminator=None,
strict=_Unset,
multiple_of=_Unset,
allow_inf_nan=_Unset,
max_digits=_Unset,
decimal_places=_Unset,
examples=None,
example=_Unset,
openapi_examples=None,
deprecated=None,
include_in_schema=True,
json_schema_extra=None,
**extra
)
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
| def Cookie( # noqa: N802
default: Annotated[
Any,
Doc(
“””
Default value if the parameter field is not set.
“””
),
] = Undefined,
,
default_factory: Annotated[
Union[Callable[[], Any], None],
Doc(
“””
A callable to generate the default value.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = _Unset,
alias: Annotated[
Optional[str],
Doc(
“””
An alternative name for the parameter field.
This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can’t use the name you want because it
is a Python reserved keyword or similar.
“””
),
] = None,
alias_priority: Annotated[
Union[int, None],
Doc(
“””
Priority of the alias. This affects whether an alias generator is used.
“””
),
] = _Unset,
# TODO: update when deprecating Pydantic v1, import these types
# validation_alias: str | AliasPath | AliasChoices | None
validation_alias: Annotated[
Union[str, None],
Doc(
“””
‘Whitelist’ validation step. The parameter field will be the single one
allowed by the alias or set of aliases defined.
“””
),
] = None,
serialization_alias: Annotated[
Union[str, None],
Doc(
“””
‘Blacklist’ validation step. The vanilla parameter field will be the
single one of the alias’ or set of aliases’ fields and all the other
fields will be ignored at serialization time.
“””
),
] = None,
title: Annotated[
Optional[str],
Doc(
“””
Human-readable title.
“””
),
] = None,
description: Annotated[
Optional[str],
Doc(
“””
Human-readable description.
“””
),
] = None,
gt: Annotated[
Optional[float],
Doc(
“””
Greater than. If set, value must be greater than this. Only applicable to
numbers.
“””
),
] = None,
ge: Annotated[
Optional[float],
Doc(
“””
Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers.
“””
),
] = None,
lt: Annotated[
Optional[float],
Doc(
“””
Less than. If set, value must be less than this. Only applicable to numbers.
“””
),
] = None,
le: Annotated[
Optional[float],
Doc(
“””
Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers.
“””
),
] = None,
min_length: Annotated[
Optional[int],
Doc(
“””
Minimum length for strings.
“””
),
] = None,
max_length: Annotated[
Optional[int],
Doc(
“””
Maximum length for strings.
“””
),
] = None,
pattern: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
] = None,
regex: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
deprecated(
“Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.”
),
] = None,
discriminator: Annotated[
Union[str, None],
Doc(
“””
Parameter field name for discriminating the type in a tagged union.
“””
),
] = None,
strict: Annotated[
Union[bool, None],
Doc(
“””
If True, strict validation is applied to the field.
“””
),
] = _Unset,
multiple_of: Annotated[
Union[float, None],
Doc(
“””
Value must be a multiple of this. Only applicable to numbers.
“””
),
] = _Unset,
allow_inf_nan: Annotated[
Union[bool, None],
Doc(
“””
Allow inf, -inf, nan. Only applicable to numbers.
“””
),
] = _Unset,
max_digits: Annotated[
Union[int, None],
Doc(
“””
Maximum number of allow digits for strings.
“””
),
] = _Unset,
decimal_places: Annotated[
Union[int, None],
Doc(
“””
Maximum number of decimal places allowed for numbers.
“””
),
] = _Unset,
examples: Annotated[
Optional[List[Any]],
Doc(
“””
Example values for this field.
“””
),
] = None,
example: Annotated[
Optional[Any],
deprecated(
“Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “
“although still supported. Use examples instead.”
),
] = _Unset,
openapi_examples: Annotated[
Optional[Dict[str, Example]],
Doc(
“””
OpenAPI-specific examples.
It will be added to the generated OpenAPI (e.g. visible at /docs).
Swagger UI (that provides the /docs interface) has better support for the
OpenAPI-specific examples than the JSON Schema examples, that’s the main
use case for this.
Read more about it in the
FastAPI docs for Declare Request Example Data.
“””
),
] = None,
deprecated: Annotated[
Optional[bool],
Doc(
“””
Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at /docs).
“””
),
] = None,
include_in_schema: Annotated[
bool,
Doc(
“””
To include (or not) this parameter field in the generated OpenAPI.
You probably don’t need it, but it’s available.
This affects the generated OpenAPI (e.g. visible at /docs).
“””
),
] = True,
json_schema_extra: Annotated[
Union[Dict[str, Any], None],
Doc(
“””
Any additional JSON schema data.
“””
),
] = None,
*extra: Annotated[
Any,
Doc(
“””
Include extra fields used by the JSON Schema.
“””
),
deprecated(
“””
The extra kwargs is deprecated. Use json_schema_extra instead.
“””
),
],
) -> Any:
return params.Cookie(
default=default,
default_factory=default_factory,
alias=alias,
alias_priority=alias_priority,
validation_alias=validation_alias,
serialization_alias=serialization_alias,
title=title,
description=description,
gt=gt,
ge=ge,
lt=lt,
le=le,
min_length=min_length,
max_length=max_length,
pattern=pattern,
regex=regex,
discriminator=discriminator,
strict=strict,
multiple_of=multiple_of,
allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
example=example,
examples=examples,
openapi_examples=openapi_examples,
deprecated=deprecated,
include_in_schema=include_in_schema,
json_schema_extra=json_schema_extra,
extra,
)
|
Header(
default=Undefined,
*,
default_factory=_Unset,
alias=None,
alias_priority=_Unset,
validation_alias=None,
serialization_alias=None,
convert_underscores=True,
title=None,
description=None,
gt=None,
ge=None,
lt=None,
le=None,
min_length=None,
max_length=None,
pattern=None,
regex=None,
discriminator=None,
strict=_Unset,
multiple_of=_Unset,
allow_inf_nan=_Unset,
max_digits=_Unset,
decimal_places=_Unset,
examples=None,
example=_Unset,
openapi_examples=None,
deprecated=None,
include_in_schema=True,
json_schema_extra=None,
**extra
)
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
convert_underscores | TYPE: bool DEFAULT: True |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
| def Header( # noqa: N802
default: Annotated[
Any,
Doc(
“””
Default value if the parameter field is not set.
“””
),
] = Undefined,
,
default_factory: Annotated[
Union[Callable[[], Any], None],
Doc(
“””
A callable to generate the default value.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = _Unset,
alias: Annotated[
Optional[str],
Doc(
“””
An alternative name for the parameter field.
This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can’t use the name you want because it
is a Python reserved keyword or similar.
“””
),
] = None,
alias_priority: Annotated[
Union[int, None],
Doc(
“””
Priority of the alias. This affects whether an alias generator is used.
“””
),
] = _Unset,
# TODO: update when deprecating Pydantic v1, import these types
# validation_alias: str | AliasPath | AliasChoices | None
validation_alias: Annotated[
Union[str, None],
Doc(
“””
‘Whitelist’ validation step. The parameter field will be the single one
allowed by the alias or set of aliases defined.
“””
),
] = None,
serialization_alias: Annotated[
Union[str, None],
Doc(
“””
‘Blacklist’ validation step. The vanilla parameter field will be the
single one of the alias’ or set of aliases’ fields and all the other
fields will be ignored at serialization time.
“””
),
] = None,
convert_underscores: Annotated[
bool,
Doc(
“””
Automatically convert underscores to hyphens in the parameter field name.
Read more about it in the
FastAPI docs for Header Parameters
“””
),
] = True,
title: Annotated[
Optional[str],
Doc(
“””
Human-readable title.
“””
),
] = None,
description: Annotated[
Optional[str],
Doc(
“””
Human-readable description.
“””
),
] = None,
gt: Annotated[
Optional[float],
Doc(
“””
Greater than. If set, value must be greater than this. Only applicable to
numbers.
“””
),
] = None,
ge: Annotated[
Optional[float],
Doc(
“””
Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers.
“””
),
] = None,
lt: Annotated[
Optional[float],
Doc(
“””
Less than. If set, value must be less than this. Only applicable to numbers.
“””
),
] = None,
le: Annotated[
Optional[float],
Doc(
“””
Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers.
“””
),
] = None,
min_length: Annotated[
Optional[int],
Doc(
“””
Minimum length for strings.
“””
),
] = None,
max_length: Annotated[
Optional[int],
Doc(
“””
Maximum length for strings.
“””
),
] = None,
pattern: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
] = None,
regex: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
deprecated(
“Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.”
),
] = None,
discriminator: Annotated[
Union[str, None],
Doc(
“””
Parameter field name for discriminating the type in a tagged union.
“””
),
] = None,
strict: Annotated[
Union[bool, None],
Doc(
“””
If True, strict validation is applied to the field.
“””
),
] = _Unset,
multiple_of: Annotated[
Union[float, None],
Doc(
“””
Value must be a multiple of this. Only applicable to numbers.
“””
),
] = _Unset,
allow_inf_nan: Annotated[
Union[bool, None],
Doc(
“””
Allow inf, -inf, nan. Only applicable to numbers.
“””
),
] = _Unset,
max_digits: Annotated[
Union[int, None],
Doc(
“””
Maximum number of allow digits for strings.
“””
),
] = _Unset,
decimal_places: Annotated[
Union[int, None],
Doc(
“””
Maximum number of decimal places allowed for numbers.
“””
),
] = _Unset,
examples: Annotated[
Optional[List[Any]],
Doc(
“””
Example values for this field.
“””
),
] = None,
example: Annotated[
Optional[Any],
deprecated(
“Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “
“although still supported. Use examples instead.”
),
] = _Unset,
openapi_examples: Annotated[
Optional[Dict[str, Example]],
Doc(
“””
OpenAPI-specific examples.
It will be added to the generated OpenAPI (e.g. visible at /docs).
Swagger UI (that provides the /docs interface) has better support for the
OpenAPI-specific examples than the JSON Schema examples, that’s the main
use case for this.
Read more about it in the
FastAPI docs for Declare Request Example Data.
“””
),
] = None,
deprecated: Annotated[
Optional[bool],
Doc(
“””
Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at /docs).
“””
),
] = None,
include_in_schema: Annotated[
bool,
Doc(
“””
To include (or not) this parameter field in the generated OpenAPI.
You probably don’t need it, but it’s available.
This affects the generated OpenAPI (e.g. visible at /docs).
“””
),
] = True,
json_schema_extra: Annotated[
Union[Dict[str, Any], None],
Doc(
“””
Any additional JSON schema data.
“””
),
] = None,
*extra: Annotated[
Any,
Doc(
“””
Include extra fields used by the JSON Schema.
“””
),
deprecated(
“””
The extra kwargs is deprecated. Use json_schema_extra instead.
“””
),
],
) -> Any:
return params.Header(
default=default,
default_factory=default_factory,
alias=alias,
alias_priority=alias_priority,
validation_alias=validation_alias,
serialization_alias=serialization_alias,
convert_underscores=convert_underscores,
title=title,
description=description,
gt=gt,
ge=ge,
lt=lt,
le=le,
min_length=min_length,
max_length=max_length,
pattern=pattern,
regex=regex,
discriminator=discriminator,
strict=strict,
multiple_of=multiple_of,
allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
example=example,
examples=examples,
openapi_examples=openapi_examples,
deprecated=deprecated,
include_in_schema=include_in_schema,
json_schema_extra=json_schema_extra,
extra,
)
|
Form(
default=Undefined,
*,
default_factory=_Unset,
media_type="application/x-www-form-urlencoded",
alias=None,
alias_priority=_Unset,
validation_alias=None,
serialization_alias=None,
title=None,
description=None,
gt=None,
ge=None,
lt=None,
le=None,
min_length=None,
max_length=None,
pattern=None,
regex=None,
discriminator=None,
strict=_Unset,
multiple_of=_Unset,
allow_inf_nan=_Unset,
max_digits=_Unset,
decimal_places=_Unset,
examples=None,
example=_Unset,
openapi_examples=None,
deprecated=None,
include_in_schema=True,
json_schema_extra=None,
**extra
)
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
media_type | The media type of this parameter field. Changing it would affect the generated OpenAPI, but currently it doesn’t affect the parsing of the data. TYPE: str DEFAULT: ‘application/x-www-form-urlencoded’ |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
| def Form( # noqa: N802
default: Annotated[
Any,
Doc(
“””
Default value if the parameter field is not set.
“””
),
] = Undefined,
,
default_factory: Annotated[
Union[Callable[[], Any], None],
Doc(
“””
A callable to generate the default value.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = _Unset,
media_type: Annotated[
str,
Doc(
“””
The media type of this parameter field. Changing it would affect the
generated OpenAPI, but currently it doesn’t affect the parsing of the data.
“””
),
] = “application/x-www-form-urlencoded”,
alias: Annotated[
Optional[str],
Doc(
“””
An alternative name for the parameter field.
This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can’t use the name you want because it
is a Python reserved keyword or similar.
“””
),
] = None,
alias_priority: Annotated[
Union[int, None],
Doc(
“””
Priority of the alias. This affects whether an alias generator is used.
“””
),
] = _Unset,
# TODO: update when deprecating Pydantic v1, import these types
# validation_alias: str | AliasPath | AliasChoices | None
validation_alias: Annotated[
Union[str, None],
Doc(
“””
‘Whitelist’ validation step. The parameter field will be the single one
allowed by the alias or set of aliases defined.
“””
),
] = None,
serialization_alias: Annotated[
Union[str, None],
Doc(
“””
‘Blacklist’ validation step. The vanilla parameter field will be the
single one of the alias’ or set of aliases’ fields and all the other
fields will be ignored at serialization time.
“””
),
] = None,
title: Annotated[
Optional[str],
Doc(
“””
Human-readable title.
“””
),
] = None,
description: Annotated[
Optional[str],
Doc(
“””
Human-readable description.
“””
),
] = None,
gt: Annotated[
Optional[float],
Doc(
“””
Greater than. If set, value must be greater than this. Only applicable to
numbers.
“””
),
] = None,
ge: Annotated[
Optional[float],
Doc(
“””
Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers.
“””
),
] = None,
lt: Annotated[
Optional[float],
Doc(
“””
Less than. If set, value must be less than this. Only applicable to numbers.
“””
),
] = None,
le: Annotated[
Optional[float],
Doc(
“””
Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers.
“””
),
] = None,
min_length: Annotated[
Optional[int],
Doc(
“””
Minimum length for strings.
“””
),
] = None,
max_length: Annotated[
Optional[int],
Doc(
“””
Maximum length for strings.
“””
),
] = None,
pattern: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
] = None,
regex: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
deprecated(
“Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.”
),
] = None,
discriminator: Annotated[
Union[str, None],
Doc(
“””
Parameter field name for discriminating the type in a tagged union.
“””
),
] = None,
strict: Annotated[
Union[bool, None],
Doc(
“””
If True, strict validation is applied to the field.
“””
),
] = _Unset,
multiple_of: Annotated[
Union[float, None],
Doc(
“””
Value must be a multiple of this. Only applicable to numbers.
“””
),
] = _Unset,
allow_inf_nan: Annotated[
Union[bool, None],
Doc(
“””
Allow inf, -inf, nan. Only applicable to numbers.
“””
),
] = _Unset,
max_digits: Annotated[
Union[int, None],
Doc(
“””
Maximum number of allow digits for strings.
“””
),
] = _Unset,
decimal_places: Annotated[
Union[int, None],
Doc(
“””
Maximum number of decimal places allowed for numbers.
“””
),
] = _Unset,
examples: Annotated[
Optional[List[Any]],
Doc(
“””
Example values for this field.
“””
),
] = None,
example: Annotated[
Optional[Any],
deprecated(
“Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “
“although still supported. Use examples instead.”
),
] = _Unset,
openapi_examples: Annotated[
Optional[Dict[str, Example]],
Doc(
“””
OpenAPI-specific examples.
It will be added to the generated OpenAPI (e.g. visible at /docs).
Swagger UI (that provides the /docs interface) has better support for the
OpenAPI-specific examples than the JSON Schema examples, that’s the main
use case for this.
Read more about it in the
FastAPI docs for Declare Request Example Data.
“””
),
] = None,
deprecated: Annotated[
Optional[bool],
Doc(
“””
Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at /docs).
“””
),
] = None,
include_in_schema: Annotated[
bool,
Doc(
“””
To include (or not) this parameter field in the generated OpenAPI.
You probably don’t need it, but it’s available.
This affects the generated OpenAPI (e.g. visible at /docs).
“””
),
] = True,
json_schema_extra: Annotated[
Union[Dict[str, Any], None],
Doc(
“””
Any additional JSON schema data.
“””
),
] = None,
*extra: Annotated[
Any,
Doc(
“””
Include extra fields used by the JSON Schema.
“””
),
deprecated(
“””
The extra kwargs is deprecated. Use json_schema_extra instead.
“””
),
],
) -> Any:
return params.Form(
default=default,
default_factory=default_factory,
media_type=media_type,
alias=alias,
alias_priority=alias_priority,
validation_alias=validation_alias,
serialization_alias=serialization_alias,
title=title,
description=description,
gt=gt,
ge=ge,
lt=lt,
le=le,
min_length=min_length,
max_length=max_length,
pattern=pattern,
regex=regex,
discriminator=discriminator,
strict=strict,
multiple_of=multiple_of,
allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
example=example,
examples=examples,
openapi_examples=openapi_examples,
deprecated=deprecated,
include_in_schema=include_in_schema,
json_schema_extra=json_schema_extra,
extra,
)
|
fastapi.File
File(
default=Undefined,
*,
default_factory=_Unset,
media_type="multipart/form-data",
alias=None,
alias_priority=_Unset,
validation_alias=None,
serialization_alias=None,
title=None,
description=None,
gt=None,
ge=None,
lt=None,
le=None,
min_length=None,
max_length=None,
pattern=None,
regex=None,
discriminator=None,
strict=_Unset,
multiple_of=_Unset,
allow_inf_nan=_Unset,
max_digits=_Unset,
decimal_places=_Unset,
examples=None,
example=_Unset,
openapi_examples=None,
deprecated=None,
include_in_schema=True,
json_schema_extra=None,
**extra
)
| PARAMETER | DESCRIPTION |
|---|
default | Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined |
default_factory | A callable to generate the default value. This doesn’t affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset |
media_type | The media type of this parameter field. Changing it would affect the generated OpenAPI, but currently it doesn’t affect the parsing of the data. TYPE: str DEFAULT: ‘multipart/form-data’ |
alias | An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can’t use the name you want because it is a Python reserved keyword or similar. TYPE: Optional[str] DEFAULT: None |
alias_priority | Priority of the alias. This affects whether an alias generator is used. TYPE: Union[int, None] DEFAULT: _Unset |
validation_alias | ‘Whitelist’ validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: Union[str, None] DEFAULT: None |
serialization_alias | ‘Blacklist’ validation step. The vanilla parameter field will be the single one of the alias’ or set of aliases’ fields and all the other fields will be ignored at serialization time. TYPE: Union[str, None] DEFAULT: None |
title | TYPE: Optional[str] DEFAULT: None |
description | Human-readable description. TYPE: Optional[str] DEFAULT: None |
gt | Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
ge | Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
lt | Less than. If set, value must be less than this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
le | Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: Optional[float] DEFAULT: None |
min_length | Minimum length for strings. TYPE: Optional[int] DEFAULT: None |
max_length | Maximum length for strings. TYPE: Optional[int] DEFAULT: None |
pattern | RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
regex | Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead. RegEx pattern for strings. TYPE: Optional[str] DEFAULT: None |
discriminator | Parameter field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None |
strict | If True, strict validation is applied to the field. TYPE: Union[bool, None] DEFAULT: _Unset |
multiple_of | Value must be a multiple of this. Only applicable to numbers. TYPE: Union[float, None] DEFAULT: _Unset |
allow_inf_nan | Allow inf, -inf, nan. Only applicable to numbers. TYPE: Union[bool, None] DEFAULT: _Unset |
max_digits | Maximum number of allow digits for strings. TYPE: Union[int, None] DEFAULT: _Unset |
decimal_places | Maximum number of decimal places allowed for numbers. TYPE: Union[int, None] DEFAULT: _Unset |
examples | Example values for this field. TYPE: Optional[List[Any]] DEFAULT: None |
example | Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead. TYPE: Optional[Any] DEFAULT: _Unset |
openapi_examples | OpenAPI-specific examples. It will be added to the generated OpenAPI (e.g. visible at /docs). Swagger UI (that provides the /docs interface) has better support for the OpenAPI-specific examples than the JSON Schema examples, that’s the main use case for this. Read more about it in the FastAPI docs for Declare Request Example Data. TYPE: Optional[Dict[str, Example]] DEFAULT: None |
deprecated | Mark this parameter field as deprecated. It will affect the generated OpenAPI (e.g. visible at /docs). TYPE: Optional[bool] DEFAULT: None |
include_in_schema | To include (or not) this parameter field in the generated OpenAPI. You probably don’t need it, but it’s available. This affects the generated OpenAPI (e.g. visible at /docs). TYPE: bool DEFAULT: True |
json_schema_extra | Any additional JSON schema data. TYPE: Union[Dict[str, Any], None] DEFAULT: None |
**extra | The extra kwargs is deprecated. Use json_schema_extra instead. Include extra fields used by the JSON Schema. TYPE: Any DEFAULT: {} |
Source code in fastapi/param_functions.py
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
| def File( # noqa: N802
default: Annotated[
Any,
Doc(
“””
Default value if the parameter field is not set.
“””
),
] = Undefined,
,
default_factory: Annotated[
Union[Callable[[], Any], None],
Doc(
“””
A callable to generate the default value.
This doesn’t affect Path parameters as the value is always required.
The parameter is available only for compatibility.
“””
),
] = _Unset,
media_type: Annotated[
str,
Doc(
“””
The media type of this parameter field. Changing it would affect the
generated OpenAPI, but currently it doesn’t affect the parsing of the data.
“””
),
] = “multipart/form-data”,
alias: Annotated[
Optional[str],
Doc(
“””
An alternative name for the parameter field.
This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can’t use the name you want because it
is a Python reserved keyword or similar.
“””
),
] = None,
alias_priority: Annotated[
Union[int, None],
Doc(
“””
Priority of the alias. This affects whether an alias generator is used.
“””
),
] = _Unset,
# TODO: update when deprecating Pydantic v1, import these types
# validation_alias: str | AliasPath | AliasChoices | None
validation_alias: Annotated[
Union[str, None],
Doc(
“””
‘Whitelist’ validation step. The parameter field will be the single one
allowed by the alias or set of aliases defined.
“””
),
] = None,
serialization_alias: Annotated[
Union[str, None],
Doc(
“””
‘Blacklist’ validation step. The vanilla parameter field will be the
single one of the alias’ or set of aliases’ fields and all the other
fields will be ignored at serialization time.
“””
),
] = None,
title: Annotated[
Optional[str],
Doc(
“””
Human-readable title.
“””
),
] = None,
description: Annotated[
Optional[str],
Doc(
“””
Human-readable description.
“””
),
] = None,
gt: Annotated[
Optional[float],
Doc(
“””
Greater than. If set, value must be greater than this. Only applicable to
numbers.
“””
),
] = None,
ge: Annotated[
Optional[float],
Doc(
“””
Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers.
“””
),
] = None,
lt: Annotated[
Optional[float],
Doc(
“””
Less than. If set, value must be less than this. Only applicable to numbers.
“””
),
] = None,
le: Annotated[
Optional[float],
Doc(
“””
Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers.
“””
),
] = None,
min_length: Annotated[
Optional[int],
Doc(
“””
Minimum length for strings.
“””
),
] = None,
max_length: Annotated[
Optional[int],
Doc(
“””
Maximum length for strings.
“””
),
] = None,
pattern: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
] = None,
regex: Annotated[
Optional[str],
Doc(
“””
RegEx pattern for strings.
“””
),
deprecated(
“Deprecated in FastAPI 0.100.0 and Pydantic v2, use pattern instead.”
),
] = None,
discriminator: Annotated[
Union[str, None],
Doc(
“””
Parameter field name for discriminating the type in a tagged union.
“””
),
] = None,
strict: Annotated[
Union[bool, None],
Doc(
“””
If True, strict validation is applied to the field.
“””
),
] = _Unset,
multiple_of: Annotated[
Union[float, None],
Doc(
“””
Value must be a multiple of this. Only applicable to numbers.
“””
),
] = _Unset,
allow_inf_nan: Annotated[
Union[bool, None],
Doc(
“””
Allow inf, -inf, nan. Only applicable to numbers.
“””
),
] = _Unset,
max_digits: Annotated[
Union[int, None],
Doc(
“””
Maximum number of allow digits for strings.
“””
),
] = _Unset,
decimal_places: Annotated[
Union[int, None],
Doc(
“””
Maximum number of decimal places allowed for numbers.
“””
),
] = _Unset,
examples: Annotated[
Optional[List[Any]],
Doc(
“””
Example values for this field.
“””
),
] = None,
example: Annotated[
Optional[Any],
deprecated(
“Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, “
“although still supported. Use examples instead.”
),
] = _Unset,
openapi_examples: Annotated[
Optional[Dict[str, Example]],
Doc(
“””
OpenAPI-specific examples.
It will be added to the generated OpenAPI (e.g. visible at /docs).
Swagger UI (that provides the /docs interface) has better support for the
OpenAPI-specific examples than the JSON Schema examples, that’s the main
use case for this.
Read more about it in the
FastAPI docs for Declare Request Example Data.
“””
),
] = None,
deprecated: Annotated[
Optional[bool],
Doc(
“””
Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at /docs).
“””
),
] = None,
include_in_schema: Annotated[
bool,
Doc(
“””
To include (or not) this parameter field in the generated OpenAPI.
You probably don’t need it, but it’s available.
This affects the generated OpenAPI (e.g. visible at /docs).
“””
),
] = True,
json_schema_extra: Annotated[
Union[Dict[str, Any], None],
Doc(
“””
Any additional JSON schema data.
“””
),
] = None,
*extra: Annotated[
Any,
Doc(
“””
Include extra fields used by the JSON Schema.
“””
),
deprecated(
“””
The extra kwargs is deprecated. Use json_schema_extra instead.
“””
),
],
) -> Any:
return params.File(
default=default,
default_factory=default_factory,
media_type=media_type,
alias=alias,
alias_priority=alias_priority,
validation_alias=validation_alias,
serialization_alias=serialization_alias,
title=title,
description=description,
gt=gt,
ge=ge,
lt=lt,
le=le,
min_length=min_length,
max_length=max_length,
pattern=pattern,
regex=regex,
discriminator=discriminator,
strict=strict,
multiple_of=multiple_of,
allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
example=example,
examples=examples,
openapi_examples=openapi_examples,
deprecated=deprecated,
include_in_schema=include_in_schema,
json_schema_extra=json_schema_extra,
extra,
)
|
我的书签
添加书签
移除书签
