// CHECKSTYLE_OFF: RegexpHeader
/**
 * This package contains non-functional annotations which are
 * used to tag various elements and help users understanding
 * how those types should be used.
 *
 * @since 4.0.0
 */
@Experimental

## Usar `async` o no usar `async`

Como las dependencias también serán llamadas por **FastAPI** (lo mismo que tus *path operation functions*), las mismas reglas aplican al definir tus funciones.

Puedes usar `async def` o `def` normal.

# WebSockets

Você pode usar <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API" class="external-link" target="_blank">WebSockets</a> com **FastAPI**.

## Instalando `WebSockets`

Garanta que você criou um [ambiente virtual](../virtual-environments.md){.internal-link target=_blank}, o ativou e instalou o `websockets`:

<div class="termy">

```console
$ pip install websockets

---> 100%
```

</div>

Para esos casos, puedes usar el `jsonable_encoder` para convertir tus datos antes de pasarlos a un response:

{* ../../docs_src/response_directly/tutorial001.py hl[6:7,21:22] *}

/// note | Nota

También podrías usar `from starlette.responses import JSONResponse`.

be inefficient for allocating only small amounts of small Go values. They're
best used in bulk, on the order of MiB of memory allocated on each use.

Note that by allowing for this limited form of manual memory allocation
that use-after-free bugs are possible with regular Go values. This package
limits the impact of these use-after-free bugs by preventing reuse of freed

     * The chain includes an AnalyzerConverter and a KatakanaToAlphabetConverter.
     *
     * @param client   the client to be used by the AnalyzerConverter
     * @param settings the settings to be used by the AnalyzerConverter
     * @return a ReadingConverterChain with the default converters added
     */

///

Puedes establecer el `operationId` de OpenAPI para ser usado en tu *path operation* con el parámetro `operation_id`.

Tienes que asegurarte de que sea único para cada operación.

{* ../../docs_src/path_operation_advanced_configuration/tutorial001.py hl[6] *}

### Usar el nombre de la *función de path operation* como el operationId

Los ejemplos aquí usan `.dict()` para compatibilidad con Pydantic v1, pero deberías usar `.model_dump()` en su lugar si puedes usar Pydantic v2.

///

### Acerca de `**user_in.dict()`

#### `.dict()` de Pydantic

`user_in` es un modelo Pydantic de la clase `UserIn`.

* `allow_origin_regex` - Uma string regex para corresponder às origens que devem ter permissão para fazer requisições de origem cruzada. Por exemplo, `'https://.*\.example\.org'`.
* `allow_methods` - Uma lista de métodos HTTP que devem ser permitidos para requisições de origem cruzada. O padrão é `['GET']`. Você pode usar `['*']` para permitir todos os métodos padrão.

    }

    /**
     * The name of the web configuration associated with this failure URL.
     * Used to identify which web crawling configuration encountered the failure.
     */
    public String webConfigName;

    /**
     * The name of the file configuration associated with this failure URL.
     * Used to identify which file crawling configuration encountered the failure.
     */
    public String fileConfigName;