# Über

Claro que este não é o frontend para os usuários finais, mas é uma ótima ferramenta automática para documentar interativamente toda sua API.

Pode ser usado pelo time de frontend (que pode ser você no caso).

Pode ser usado por aplicações e sistemas third party (de terceiros).

E também pode ser usada por você mesmo, para debugar, checar e testar a mesma aplicação.

## O Fluxo da `senha`

* `openapi_url`: a URL onde a página HTML para a documentação pode obter o esquema OpenAPI para a sua API. Você pode usar aqui o atributo `app.openapi_url`.
* `title`: o título da sua API.
* `oauth2_redirect_url`: você pode usar `app.swagger_ui_oauth2_redirect_url` aqui para usar o padrão.

# Modelos de Formulario

Puedes usar **modelos de Pydantic** para declarar **campos de formulario** en FastAPI.

/// info | Información

Para usar formularios, primero instala <a href="https://github.com/Kludex/python-multipart" class="external-link" target="_blank">`python-multipart`</a>.

Asegúrate de crear un [entorno virtual](../virtual-environments.md){.internal-link target=_blank}, activarlo, y luego instalarlo, por ejemplo:

```console

    SwaggerUIBundle.SwaggerUIStandalonePreset
]
```

Estos son objetos de **JavaScript**, no strings, por lo que no puedes pasarlos directamente desde código de Python.

import org.opensearch.transport.client.Client;

/**
 * AnalyzerNormalizer is a class that implements the Normalizer interface.
 * It uses an OpenSearch client and settings to normalize text based on specified languages.
 */
public class AnalyzerNormalizer implements Normalizer {
    /**
     * The OpenSearch client used for analyzing text.
     */
    protected final Client client;

    /**
     * The settings for the analyzer.
     */

* `openapi_url`: la URL donde la página HTML para la documentación puede obtener el OpenAPI esquema de tu API. Puedes usar aquí el atributo `app.openapi_url`.
* `title`: el título de tu API.
* `oauth2_redirect_url`: puedes usar `app.swagger_ui_oauth2_redirect_url` aquí para usar el valor predeterminado.

Si tienes una versión más antigua, obtendrás errores al intentar usar `Annotated`.

Asegúrate de [Actualizar la versión de FastAPI](../deployment/versions.md#upgrading-the-fastapi-versions){.internal-link target=_blank} a al menos 0.95.1 antes de usar `Annotated`.

///

## Usar `Annotated` en el tipo del parámetro `q`

/// note | Detalles Técnicos

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

**FastAPI** proporciona los mismos `starlette.responses` como `fastapi.responses` solo como una conveniencia para ti, el desarrollador. Pero la mayoría de los responses disponibles vienen directamente de Starlette.

// 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