/// note | Nota

FastAPI sabrá que el valor de `q` no es requerido por el valor por defecto `= None`.

Tener `str | None` permitirá que tu editor te dé un mejor soporte y detecte errores.

///

## Validaciones adicionales { #additional-validation }

/// note | Nota

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

Ter `str | None` permitirá que seu editor lhe ofereça melhor suporte e detecte erros.

///

## Validação adicional { #additional-validation }

  - zuplo-oss
  - zuplo
  - Kong
  - speakeasy-api
  - jess-render
  - blockbee-io
  - liblaber
  - render-sponsorships
  - renderinc
  - stainless-api
  - snapit-cypher
  - coderabbitai
  - permitio
  - LambdaTest-Inc
  - dribia
  - madisonredtfeldt
  - railwayapp
  - subtotal
  - requestly

Por exemplo, se o cliente tentar enviar os campos de formulário:

* `username`: `Rick`
* `password`: `Portal Gun`
* `extra`: `Mr. Poopybutthole`

Ele receberá um retorno de erro informando-o que o campo `extra` não é permitido:

```json
{
    "detail": [
        {
            "type": "extra_forbidden",
            "loc": ["body", "extra"],
            "msg": "Extra inputs are not permitted",
            "input": "Mr. Poopybutthole"

Por ejemplo, supongamos que quieres tener una *path operation* que permita actualizar elementos, y devuelva códigos de estado HTTP de 200 "OK" cuando sea exitoso.

Por ejemplo, si el cliente intenta enviar los campos de formulario:

* `username`: `Rick`
* `password`: `Portal Gun`
* `extra`: `Mr. Poopybutthole`

Recibirá un response de error indicando que el campo `extra` no está permitido:

```json
{
    "detail": [
        {
            "type": "extra_forbidden",
            "loc": ["body", "extra"],
            "msg": "Extra inputs are not permitted",
            "input": "Mr. Poopybutthole"

Pero agregar las anotaciones de tipos permitirá que tu editor te brinde un mejor soporte y detecte errores.

///

## Sin Pydantic { #without-pydantic }

  - login: databento
    avatarUrl: https://avatars.githubusercontent.com/u/64141749?v=4
    url: https://github.com/databento
  - login: permitio
    avatarUrl: https://avatars.githubusercontent.com/u/71775833?v=4
    url: https://github.com/permitio
- - login: Ponte-Energy-Partners
    avatarUrl: https://avatars.githubusercontent.com/u/114745848?v=4
    url: https://github.com/Ponte-Energy-Partners

* `Field(index=True)` le dice a SQLModel que debe crear un **índice SQL** para esta columna, lo que permitirá búsquedas más rápidas en la base de datos cuando se lean datos filtrados por esta columna.

    SQLModel sabrá que algo declarado como `str` será una columna SQL de tipo `TEXT` (o `VARCHAR`, dependiendo de la base de datos).

Así que, lo que haremos a continuación es agregar el código para documentar cómo debería verse esa *API externa* para recibir el callback de *tu API*.

Esa documentación aparecerá en la Swagger UI en `/docs` en tu API, y permitirá a los desarrolladores externos saber cómo construir la *API externa*.

Este ejemplo no implementa el callback en sí (eso podría ser solo una línea de código), solo la parte de documentación.

/// tip | Consejo