{* ../../docs_src/body/tutorial001_py310.py hl[5:9] *}


Al igual que al declarar parámetros de query, cuando un atributo del modelo tiene un valor por defecto, no es obligatorio. De lo contrario, es obligatorio. Usa `None` para hacerlo solo opcional.

Por ejemplo, el modelo anterior declara un “`object`” JSON (o `dict` en Python) como:

```JSON
{
    "name": "Foo",

constraints.Future.message = {item} debe ser una fecha futura.
constraints.Max.message = {item} debe ser menor o igual que {value}.
constraints.Min.message = {item} debe ser mayor o igual que {value}.
constraints.NotNull.message = {item} es obligatorio.
constraints.Null.message = {item} debe ser nulo.
constraints.Past.message = {item} debe ser una fecha pasada.
constraints.Pattern.message = {item} no coincide con "{regexp}".

{* ../../docs_src/query_params/tutorial005_py310.py hl[6:7] *}

Aqui o parâmetro da consulta `needy` é um valor obrigatório, do tipo `str`.

Se você abrir no seu navegador a URL:

```
http://127.0.0.1:8000/items/foo-item
```

... sem adicionar o parâmetro obrigatório `needy`, você verá um erro como:

A maneira de descrever isso no OpenAPI é marcar esse campo como **obrigatório**, porque ele sempre estará lá.

Por causa disso, o JSON Schema para um modelo pode ser diferente dependendo se ele é usado para **entrada ou saída**:

* para **entrada**, o `description` **não será obrigatório**
* para **saída**, ele será **obrigatório** (e possivelmente `None`, ou em termos de JSON, `null`)

constraints.Future.message = {item} deve ser uma data futura.
constraints.Max.message = {item} deve ser menor ou igual a {value}.
constraints.Min.message = {item} deve ser maior ou igual a {value}.
constraints.NotNull.message = {item} é obrigatório.
constraints.Null.message = {item} deve ser nulo.
constraints.Past.message = {item} deve ser uma data passada.
constraints.Pattern.message = {item} não corresponde a "{regexp}".

{* ../../docs_src/path_params_numeric_validations/tutorial001_an_py310.py hl[10] *}

/// note | Nota

Um parâmetro de path é sempre obrigatório, pois precisa fazer parte do path. Mesmo que você o declare como `None` ou defina um valor padrão, isso não afetaria nada, ele ainda seria sempre obrigatório.

///

## Ordene os parâmetros de acordo com sua necessidade { #order-the-parameters-as-you-need }

/// tip | Dica

/// note | Nota

O FastAPI saberá que o valor de `q` não é obrigatório por causa do valor padrão `= None`.

O `str | None` não é utilizado pelo FastAPI para determinar que o valor não é obrigatório, ele saberá que não é obrigatório porque tem um valor padrão `= None`.

Mas adicionar as anotações de tipo permitirá ao seu editor oferecer um suporte melhor e detectar erros.

Acho que `Union[SomeType, None]` é mais explícito quanto ao significado.

É apenas uma questão de palavras e nomes. Mas essas palavras podem influenciar como você e sua equipe pensam sobre o código.

<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or an unambiguous set of steps to -->

-kv | output inner key value pairs as newly formed objects
-v | output depth and offset details for each value
-h | display help dialog

## Benchmarks

Obligatory benchmarks performed on files with arrays of objects, where the decoded objects are to be extracted.

Two file sizes are used -- regular (1.6mb, 1000 objects) and large (128mb, 100000 objects)