Saltar al contenido

Clase FastAPI

Aquí está la información de referencia para la clase FastAPI, con todos sus parámetros, atributos y métodos.

Puedes importar la clase FastAPI directamente desde fastapi:

from fastapi import FastAPI

fastapi.FastAPI

FastAPI(
    *,
    debug=False,
    routes=None,
    title="FastAPI",
    summary=None,
    description="",
    version="0.1.0",
    openapi_url="/openapi.json",
    openapi_tags=None,
    servers=None,
    dependencies=None,
    default_response_class=Default(JSONResponse),
    redirect_slashes=True,
    docs_url="/docs",
    redoc_url="/redoc",
    swagger_ui_oauth2_redirect_url="/docs/oauth2-redirect",
    swagger_ui_init_oauth=None,
    middleware=None,
    exception_handlers=None,
    on_startup=None,
    on_shutdown=None,
    lifespan=None,
    terms_of_service=None,
    contact=None,
    license_info=None,
    openapi_prefix="",
    root_path="",
    root_path_in_servers=True,
    responses=None,
    callbacks=None,
    webhooks=None,
    deprecated=None,
    include_in_schema=True,
    swagger_ui_parameters=None,
    generate_unique_id_function=Default(generate_unique_id),
    separate_input_output_schemas=True,
    openapi_external_docs=None,
    strict_content_type=True,
    **extra
)

Hereda de: Starlette

Clase de la aplicación FastAPI, el punto de entrada principal para usar FastAPI.

Lee más en la documentación de FastAPI para Primeros pasos.

Ejemplo

from fastapi import FastAPI

app = FastAPI()
PARÁMETRO DESCRIPCIÓN
debug

Booleano que indica si se deben devolver tracebacks de depuración en errores del servidor.

Lee más en la documentación de Starlette para Aplicaciones.

TYPE: bool DEFAULT: False

routes

Nota: probablemente no deberías usar este parámetro, se hereda de Starlette y se mantiene por compatibilidad.


Una lista de rutas para atender peticiones HTTP y WebSocket entrantes.

TYPE: list[BaseRoute] | None DEFAULT: None

title

El título de la API.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(title="ChimichangApp")

TYPE: str POR DEFECTO: 'FastAPI'

summary

Un resumen breve de la API.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(summary="Deadpond's favorite app. Nuff said.")

TYPE: str | None DEFAULT: None

description

Una descripción de la API. Soporta Markdown (usando sintaxis CommonMark).

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(
    description="""
                ChimichangApp API helps you do awesome stuff. 🚀

                ## Items

                You can **read items**.

                ## Users

                You will be able to:

                * **Create users** (_not implemented_).
                * **Read users** (_not implemented_).

                """
)

TYPE: str DEFAULT: ''

version

La versión de la API.

Nota Esta es la versión de tu aplicación, no la versión de la especificación OpenAPI ni la versión de FastAPI que se está usando.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(version="0.0.1")

TYPE: str POR DEFECTO: '0.1.0'

openapi_url

La URL desde donde se servirá el esquema OpenAPI.

Si lo estableces en None, no se servirá públicamente ningún esquema OpenAPI, y los endpoints automáticos por defecto /docs y /redoc también serán deshabilitados.

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(openapi_url="/api/v1/openapi.json")

TYPE: str | None POR DEFECTO: '/openapi.json'

openapi_tags

Una lista de tags usados por OpenAPI, estos son los mismos tags que puedes establecer en las operaciones de ruta, como:

  • @app.get("/users/", tags=["users"])
  • @app.get("/items/", tags=["items"])

El orden de los tags puede ser usado para especificar el orden mostrado en herramientas como Swagger UI, usado en la ruta automática /docs.

No es obligatorio especificar todos los tags usados.

Los tags que no son declarados PUEDEN ser organizados aleatoriamente o basados en la lógica de las herramientas. Cada nombre de tag en la lista DEBE ser único.

El valor de cada elemento es un dict que contiene:

  • name: El nombre del tag.
  • description: Una breve descripción del tag. La sintaxis CommonMark PUEDE ser usada para una representación de texto enriquecido.
  • externalDocs: Additional external documentation for this tag. If provided, it would contain a dict with:
    • description: Una breve descripción de la documentación objetivo. La sintaxis CommonMark PUEDE ser usada para una representación de texto enriquecido.
    • url: La URL para la documentación objetivo. El valor DEBE estar en formato de URL.

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

tags_metadata = [
    {
        "name": "users",
        "description": "Operations with users. The **login** logic is also here.",
    },
    {
        "name": "items",
        "description": "Manage items. So _fancy_ they have their own docs.",
        "externalDocs": {
            "description": "Items external docs",
            "url": "https://fastapi.tiangolo.com/",
        },
    },
]

app = FastAPI(openapi_tags=tags_metadata)

TIPO: list[dict[str, Any]] | None DEFAULT: None

servers

Una lista de dicts con información de conectividad a un servidor objetivo.

Lo usarías, por ejemplo, si tu aplicación es servida desde diferentes dominios y quieres usar el mismo Swagger UI en el navegador para interactuar con cada uno de ellos (en lugar de tener múltiples pestañas del navegador abiertas). O si quieres dejar fijas las URLs posibles.

Si la lista de servers no se proporciona, o es una lista vacía, la propiedad servers en el OpenAPI generado será:

  • un dict con un valor url del punto de montaje de la aplicación (root_path) si es diferente de /.
  • de lo contrario, la propiedad servers será omitida del esquema OpenAPI.

Cada elemento en la lista es un dict que contiene:

  • url: Una URL al host objetivo. Esta URL soporta Variables de Servidor y PUEDE ser relativa, para indicar que la ubicación del host es relativa a la ubicación donde se está sirviendo el documento OpenAPI. Las sustituciones de variables se harán cuando una variable sea nombrada entre{llaves}.
  • description: Una cadena opcional que describe el host designado por la URL. La sintaxis CommonMark PUEDE ser usada para una representación de texto enriquecido.
  • variables: Un dict entre un nombre de variable y su valor. El valor es usado para sustitución en la plantilla de URL del servidor.

Lee más en la documentación de FastAPI para Detrás de un Proxy.

Example

from fastapi import FastAPI

app = FastAPI(
    servers=[
        {"url": "https://stag.example.com", "description": "Staging environment"},
        {"url": "https://prod.example.com", "description": "Production environment"},
    ]
)

TIPO: list[dict[str, str | Any]] | None DEFAULT: None

dependencies

Una lista de dependencias globales, serán aplicadas a cada operación de ruta, incluyendo en sub-routers.

Lee más sobre esto en la documentación de FastAPI para Dependencias globales.

Example

from fastapi import Depends, FastAPI

from .dependencies import func_dep_1, func_dep_2

app = FastAPI(dependencies=[Depends(func_dep_1), Depends(func_dep_2)])

TYPE: Sequence[Depends] | None DEFAULT: None

default_response_class

La clase de respuesta por defecto a usar.

Lee más en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

Example

from fastapi import FastAPI
from fastapi.responses import ORJSONResponse

app = FastAPI(default_response_class=ORJSONResponse)

TYPE: type[Response] DEFAULT: Default(JSONResponse)

redirect_slashes

Si detectar y redirigir las barras en las URLs cuando el cliente no usa el mismo formato.

Example

from fastapi import FastAPI

app = FastAPI(redirect_slashes=True)  # the default

@app.get("/items/")
async def read_items():
    return [{"item_id": "Foo"}]

Con esta aplicación, si un cliente va a /items (sin una barra final), será automáticamente redirigido con un código de estado HTTP 307 a /items/.

TYPE: bool DEFAULT: True

docs_url

La ruta a la documentación interactiva automática de la API. Es manejada en el navegador por Swagger UI.

La URL por defecto es /docs. Puedes deshabilitarla estableciéndola en None.

Si openapi_url está establecido en None, esto será automáticamente deshabilitado.

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url=None)

TYPE: str | None POR DEFECTO: '/docs'

redoc_url

La ruta a la documentación interactiva automática alternativa de la API proporcionada por ReDoc.

La URL por defecto es /redoc. Puedes deshabilitarla estableciéndola en None.

Si openapi_url está establecido en None, esto será automáticamente deshabilitado.

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url="redocumentation")

TYPE: str | None POR DEFECTO: '/redoc'

swagger_ui_oauth2_redirect_url

El endpoint de redirección de OAuth2 para Swagger UI.

Por defecto es /docs/oauth2-redirect.

Esto solo se usa si usas OAuth2 (con el botón "Authorize") con Swagger UI.

TYPE: str | None POR DEFECTO: '/docs/oauth2-redirect'

swagger_ui_init_oauth

Configuración de OAuth2 para Swagger UI, por defecto mostrada en /docs.

Lee más sobre las opciones de configuración disponibles en la documentación de Swagger UI.

TYPE: dict[str, Any] | None DEFAULT: None

middleware

Lista de middleware a agregar al crear la aplicación.

En FastAPI normalmente harías esto con app.add_middleware() en su lugar.

Lee más en la documentación de FastAPI para Middleware.

TIPO: Sequence[Middleware] | None DEFAULT: None

exception_handlers

Un diccionario con manejadores para excepciones.

En FastAPI, normalmente usarías el decorador @app.exception_handler().

Lee más en la documentación de FastAPI para Manejo de errores.

TIPO: dict[int | type[Exception], Callable[[Request, Any], Coroutine[Any, Any, Response]]] | None POR DEFECTO: None

on_startup

Una lista de funciones manejadoras de eventos de startup.

Deberías usar en su lugar los manejadores de lifespan.

Lee más en la documentación de FastAPI para lifespan.

TYPE: Sequence[Callable[[], Any]] | None DEFAULT: None

on_shutdown

Una lista de funciones manejadoras de eventos de shutdown.

Deberías usar en su lugar los manejadores de lifespan.

Lee más en la documentación de FastAPI para lifespan.

TYPE: Sequence[Callable[[], Any]] | None DEFAULT: None

lifespan

Un manejador context manager de Lifespan. Esto reemplaza las funciones de startup y shutdown con un único context manager.

Lee más en la documentación de FastAPI para lifespan.

TIPO: Lifespan[AppType] | None DEFAULT: None

terms_of_service

Una URL a los Términos de Servicio para tu API.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

app = FastAPI(terms_of_service="http://example.com/terms/")

TYPE: str | None DEFAULT: None

contact

Un diccionario con la información de contacto para la API expuesta.

Puede contener varios campos.

  • name: (str) El nombre de la persona/organización de contacto.
  • url: (str) Una URL que apunta a la información de contacto. DEBE estar en formato de URL.
  • email: (str) El correo electrónico de la persona/organización de contacto. DEBE estar en formato de correo electrónico.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

app = FastAPI(
    contact={
        "name": "Deadpoolio the Amazing",
        "url": "http://x-force.example.com/contact/",
        "email": "dp@x-force.example.com",
    }
)

TIPO: dict[str, str | Any] | None DEFAULT: None

license_info

Un diccionario con la información de licencia para la API expuesta.

Puede contener varios campos.

  • name: (str) OBLIGATORIO (si se establece license_info). El nombre de licencia usado para la API.
  • identifier: (str) Una expresión de licencia SPDX para la API. El campo identifier es mutuamente excluyente del campo url. Disponible desde OpenAPI 3.1.0, FastAPI 0.99.0.
  • url: (str) Una URL a la licencia usada para la API. Esto DEBE ser en formato de URL.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más en la documentación de FastAPI para Metadatos y URLs de documentación.

Example

app = FastAPI(
    license_info={
        "name": "Apache 2.0",
        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
    }
)

TIPO: dict[str, str | Any] | None DEFAULT: None

openapi_prefix

Un prefijo de URL para la URL de OpenAPI.

TYPE: str DEFAULT: ''

root_path

Un prefijo de ruta manejado por un proxy que no es visto por la aplicación pero sí por los clientes externos, lo cual afecta cosas como Swagger UI.

Lee más sobre esto en la documentación de FastAPI para Detrás de un Proxy.

Example

from fastapi import FastAPI

app = FastAPI(root_path="/api/v1")

TYPE: str DEFAULT: ''

root_path_in_servers

Para deshabilitar la generación automática de las URLs en el campo servers en el OpenAPI autogenerado usando root_path.

Lee más sobre esto en la documentación de FastAPI para Detrás de un Proxy.

Example

from fastapi import FastAPI

app = FastAPI(root_path_in_servers=False)

TYPE: bool DEFAULT: True

responses

Respuestas adicionales a mostrar en OpenAPI.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Respuestas Adicionales en OpenAPI.

Y en la documentación de FastAPI para Aplicaciones Más Grandes.

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

callbacks

Callbacks de OpenAPI que deberían aplicarse a todas las operaciones de ruta.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

webhooks

Agrega webhooks de OpenAPI. Esto es similar a callbacks pero no depende de operaciones de ruta específicas.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Nota: Esto está disponible desde OpenAPI 3.1.0, FastAPI 0.99.0.

Lee más sobre esto en la documentación de FastAPI para Webhooks de OpenAPI.

TIPO: APIRouter | None POR DEFECTO: None

deprecated

Marca todas las operaciones de ruta como deprecadas. Probablemente no lo necesites, pero está disponible.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: bool | None DEFAULT: None

include_in_schema

Para incluir (o no) todas las operaciones de ruta en el OpenAPI generado. Probablemente no lo necesites, pero está disponible.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

swagger_ui_parameters

Parámetros para configurar Swagger UI, la documentación interactiva autogenerada de la API (por defecto en /docs).

Lee más sobre esto en la documentación de FastAPI sobre cómo configurar Swagger UI.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

separate_input_output_schemas

Si generar esquemas OpenAPI separados para el cuerpo de petición y el cuerpo de respuesta cuando los resultados serían más precisos.

Esto es particularmente útil cuando se generan clientes automáticamente.

Por ejemplo, si tienes un modelo como:

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    tags: list[str] = []

Cuando Item es usado para entrada, un cuerpo de petición, tags no es obligatorio, el cliente no tiene que proporcionarlo.

Pero cuando se usa Item para salida, para un cuerpo de respuesta, tags está siempre disponible porque tiene un valor por defecto, incluso si es solo una lista vacía. Así que, el cliente debería poder esperarlo siempre.

En este caso, habría dos esquemas diferentes, uno para entrada y otro para salida.

Lee más sobre esto en la documentación de FastAPI sobre cómo separar esquemas para entrada y salida

TYPE: bool DEFAULT: True

openapi_external_docs

Este campo te permite proporcionar enlaces adicionales de documentación externa. Si se proporciona, debe ser un diccionario que contenga:

  • description: Una breve descripción de la documentación externa.
  • url: La URL que apunta a la documentación externa. El valor DEBE ser un formato de URL válido.

Example:

from fastapi import FastAPI

external_docs = {
    "description": "Detailed API Reference",
    "url": "https://example.com/api-docs",
}

app = FastAPI(openapi_external_docs=external_docs)

TYPE: dict[str, Any] | None DEFAULT: None

strict_content_type

Habilitar verificación estricta de los headers Content-Type de la petición.

Cuando es True (el valor por defecto), las peticiones con un body que no incluyen un header Content-Type no se procesarán como JSON.

Esto previene potenciales ataques de cross-site request forgery (CSRF) que explotan la capacidad del navegador de enviar peticiones sin un header Content-Type, eludiendo las verificaciones CORS preflight. En particular aplicable para apps que necesitan ejecutarse localmente (en localhost).

Cuando es False, las peticiones sin un header Content-Type tendrán su body procesado como JSON, lo que mantiene compatibilidad con ciertos clientes que no envían headers Content-Type.

Lee más sobre esto en la documentación de FastAPI para Content-Type Estricto.

TYPE: bool DEFAULT: True

**extra

Argumentos de palabra clave extra para ser almacenados en la aplicación, no usados por FastAPI en ningún lugar.

TYPE: Any POR DEFECTO: {}

Código fuente en fastapi/applications.py
def __init__(
    self: AppType,
    *,
    debug: Annotated[
        bool,
        Doc(
            """
            Boolean indicating if debug tracebacks should be returned on server
            errors.

            Read more in the
            [Starlette docs for Applications](https://www.starlette.dev/applications/#instantiating-the-application).
            """
        ),
    ] = False,
    routes: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            **Note**: you probably shouldn't use this parameter, it is inherited
            from Starlette and supported for compatibility.

            ---

            A list of routes to serve incoming HTTP and WebSocket requests.
            """
        ),
        deprecated(
            """
            You normally wouldn't use this parameter with FastAPI, it is inherited
            from Starlette and supported for compatibility.

            In FastAPI, you normally would use the *path operation methods*,
            like `app.get()`, `app.post()`, etc.
            """
        ),
    ] = None,
    title: Annotated[
        str,
        Doc(
            """
            The title of the API.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(title="ChimichangApp")
            ```
            """
        ),
    ] = "FastAPI",
    summary: Annotated[
        str | None,
        Doc(
            """
            A short summary of the API.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(summary="Deadpond's favorite app. Nuff said.")
            ```
            """
        ),
    ] = None,
    description: Annotated[
        str,
        Doc(
            '''
            A description of the API. Supports Markdown (using
            [CommonMark syntax](https://commonmark.org/)).

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(
                description="""
                            ChimichangApp API helps you do awesome stuff. 🚀

                            ## Items

                            You can **read items**.

                            ## Users

                            You will be able to:

                            * **Create users** (_not implemented_).
                            * **Read users** (_not implemented_).

                            """
            )
            ```
            '''
        ),
    ] = "",
    version: Annotated[
        str,
        Doc(
            """
            The version of the API.

            **Note** This is the version of your application, not the version of
            the OpenAPI specification nor the version of FastAPI being used.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(version="0.0.1")
            ```
            """
        ),
    ] = "0.1.0",
    openapi_url: Annotated[
        str | None,
        Doc(
            """
            The URL where the OpenAPI schema will be served from.

            If you set it to `None`, no OpenAPI schema will be served publicly, and
            the default automatic endpoints `/docs` and `/redoc` will also be
            disabled.

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#openapi-url).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(openapi_url="/api/v1/openapi.json")
            ```
            """
        ),
    ] = "/openapi.json",
    openapi_tags: Annotated[
        list[dict[str, Any]] | None,
        Doc(
            """
            A list of tags used by OpenAPI, these are the same `tags` you can set
            in the *path operations*, like:

            * `@app.get("/users/", tags=["users"])`
            * `@app.get("/items/", tags=["items"])`

            The order of the tags can be used to specify the order shown in
            tools like Swagger UI, used in the automatic path `/docs`.

            It's not required to specify all the tags used.

            The tags that are not declared MAY be organized randomly or based
            on the tools' logic. Each tag name in the list MUST be unique.

            The value of each item is a `dict` containing:

            * `name`: The name of the tag.
            * `description`: A short description of the tag.
                [CommonMark syntax](https://commonmark.org/) MAY be used for rich
                text representation.
            * `externalDocs`: Additional external documentation for this tag. If
                provided, it would contain a `dict` with:
                * `description`: A short description of the target documentation.
                    [CommonMark syntax](https://commonmark.org/) MAY be used for
                    rich text representation.
                * `url`: The URL for the target documentation. Value MUST be in
                    the form of a URL.

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-tags).

            **Example**

            ```python
            from fastapi import FastAPI

            tags_metadata = [
                {
                    "name": "users",
                    "description": "Operations with users. The **login** logic is also here.",
                },
                {
                    "name": "items",
                    "description": "Manage items. So _fancy_ they have their own docs.",
                    "externalDocs": {
                        "description": "Items external docs",
                        "url": "https://fastapi.tiangolo.com/",
                    },
                },
            ]

            app = FastAPI(openapi_tags=tags_metadata)
            ```
            """
        ),
    ] = None,
    servers: Annotated[
        list[dict[str, str | Any]] | None,
        Doc(
            """
            A `list` of `dict`s with connectivity information to a target server.

            You would use it, for example, if your application is served from
            different domains and you want to use the same Swagger UI in the
            browser to interact with each of them (instead of having multiple
            browser tabs open). Or if you want to leave fixed the possible URLs.

            If the servers `list` is not provided, or is an empty `list`, the
            `servers` property in the generated OpenAPI will be:

            * a `dict` with a `url` value of the application's mounting point
            (`root_path`) if it's different from `/`.
            * otherwise, the `servers` property will be omitted from the OpenAPI
            schema.

            Each item in the `list` is a `dict` containing:

            * `url`: A URL to the target host. This URL supports Server Variables
            and MAY be relative, to indicate that the host location is relative
            to the location where the OpenAPI document is being served. Variable
            substitutions will be made when a variable is named in `{`brackets`}`.
            * `description`: An optional string describing the host designated by
            the URL. [CommonMark syntax](https://commonmark.org/) MAY be used for
            rich text representation.
            * `variables`: A `dict` between a variable name and its value. The value
                is used for substitution in the server's URL template.

            Read more in the
            [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#additional-servers).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(
                servers=[
                    {"url": "https://stag.example.com", "description": "Staging environment"},
                    {"url": "https://prod.example.com", "description": "Production environment"},
                ]
            )
            ```
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of global dependencies, they will be applied to each
            *path operation*, including in sub-routers.

            Read more about it in the
            [FastAPI docs for Global Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/global-dependencies/).

            **Example**

            ```python
            from fastapi import Depends, FastAPI

            from .dependencies import func_dep_1, func_dep_2

            app = FastAPI(dependencies=[Depends(func_dep_1), Depends(func_dep_2)])
            ```
            """
        ),
    ] = None,
    default_response_class: Annotated[
        type[Response],
        Doc(
            """
            The default response class to be used.

            Read more in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).

            **Example**

            ```python
            from fastapi import FastAPI
            from fastapi.responses import ORJSONResponse

            app = FastAPI(default_response_class=ORJSONResponse)
            ```
            """
        ),
    ] = Default(JSONResponse),
    redirect_slashes: Annotated[
        bool,
        Doc(
            """
            Whether to detect and redirect slashes in URLs when the client doesn't
            use the same format.

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(redirect_slashes=True)  # the default

            @app.get("/items/")
            async def read_items():
                return [{"item_id": "Foo"}]
            ```

            With this app, if a client goes to `/items` (without a trailing slash),
            they will be automatically redirected with an HTTP status code of 307
            to `/items/`.
            """
        ),
    ] = True,
    docs_url: Annotated[
        str | None,
        Doc(
            """
            The path to the automatic interactive API documentation.
            It is handled in the browser by Swagger UI.

            The default URL is `/docs`. You can disable it by setting it to `None`.

            If `openapi_url` is set to `None`, this will be automatically disabled.

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#docs-urls).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(docs_url="/documentation", redoc_url=None)
            ```
            """
        ),
    ] = "/docs",
    redoc_url: Annotated[
        str | None,
        Doc(
            """
            The path to the alternative automatic interactive API documentation
            provided by ReDoc.

            The default URL is `/redoc`. You can disable it by setting it to `None`.

            If `openapi_url` is set to `None`, this will be automatically disabled.

            Read more in the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#docs-urls).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(docs_url="/documentation", redoc_url="redocumentation")
            ```
            """
        ),
    ] = "/redoc",
    swagger_ui_oauth2_redirect_url: Annotated[
        str | None,
        Doc(
            """
            The OAuth2 redirect endpoint for the Swagger UI.

            By default it is `/docs/oauth2-redirect`.

            This is only used if you use OAuth2 (with the "Authorize" button)
            with Swagger UI.
            """
        ),
    ] = "/docs/oauth2-redirect",
    swagger_ui_init_oauth: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            OAuth2 configuration for the Swagger UI, by default shown at `/docs`.

            Read more about the available configuration options in the
            [Swagger UI docs](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/).
            """
        ),
    ] = None,
    middleware: Annotated[
        Sequence[Middleware] | None,
        Doc(
            """
            List of middleware to be added when creating the application.

            In FastAPI you would normally do this with `app.add_middleware()`
            instead.

            Read more in the
            [FastAPI docs for Middleware](https://fastapi.tiangolo.com/tutorial/middleware/).
            """
        ),
    ] = None,
    exception_handlers: Annotated[
        dict[
            int | type[Exception],
            Callable[[Request, Any], Coroutine[Any, Any, Response]],
        ]
        | None,
        Doc(
            """
            A dictionary with handlers for exceptions.

            In FastAPI, you would normally use the decorator
            `@app.exception_handler()`.

            Read more in the
            [FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/).
            """
        ),
    ] = None,
    on_startup: Annotated[
        Sequence[Callable[[], Any]] | None,
        Doc(
            """
            A list of startup event handler functions.

            You should instead use the `lifespan` handlers.

            Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
            """
        ),
    ] = None,
    on_shutdown: Annotated[
        Sequence[Callable[[], Any]] | None,
        Doc(
            """
            A list of shutdown event handler functions.

            You should instead use the `lifespan` handlers.

            Read more in the
            [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
            """
        ),
    ] = None,
    lifespan: Annotated[
        Lifespan[AppType] | None,
        Doc(
            """
            A `Lifespan` context manager handler. This replaces `startup` and
            `shutdown` functions with a single context manager.

            Read more in the
            [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
            """
        ),
    ] = None,
    terms_of_service: Annotated[
        str | None,
        Doc(
            """
            A URL to the Terms of Service for your API.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more at the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            app = FastAPI(terms_of_service="http://example.com/terms/")
            ```
            """
        ),
    ] = None,
    contact: Annotated[
        dict[str, str | Any] | None,
        Doc(
            """
            A dictionary with the contact information for the exposed API.

            It can contain several fields.

            * `name`: (`str`) The name of the contact person/organization.
            * `url`: (`str`) A URL pointing to the contact information. MUST be in
                the format of a URL.
            * `email`: (`str`) The email address of the contact person/organization.
                MUST be in the format of an email address.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more at the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            app = FastAPI(
                contact={
                    "name": "Deadpoolio the Amazing",
                    "url": "http://x-force.example.com/contact/",
                    "email": "dp@x-force.example.com",
                }
            )
            ```
            """
        ),
    ] = None,
    license_info: Annotated[
        dict[str, str | Any] | None,
        Doc(
            """
            A dictionary with the license information for the exposed API.

            It can contain several fields.

            * `name`: (`str`) **REQUIRED** (if a `license_info` is set). The
                license name used for the API.
            * `identifier`: (`str`) An [SPDX](https://spdx.dev/) license expression
                for the API. The `identifier` field is mutually exclusive of the `url`
                field. Available since OpenAPI 3.1.0, FastAPI 0.99.0.
            * `url`: (`str`) A URL to the license used for the API. This MUST be
                the format of a URL.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more at the
            [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).

            **Example**

            ```python
            app = FastAPI(
                license_info={
                    "name": "Apache 2.0",
                    "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
                }
            )
            ```
            """
        ),
    ] = None,
    openapi_prefix: Annotated[
        str,
        Doc(
            """
            A URL prefix for the OpenAPI URL.
            """
        ),
        deprecated(
            """
            "openapi_prefix" has been deprecated in favor of "root_path", which
            follows more closely the ASGI standard, is simpler, and more
            automatic.
            """
        ),
    ] = "",
    root_path: Annotated[
        str,
        Doc(
            """
            A path prefix handled by a proxy that is not seen by the application
            but is seen by external clients, which affects things like Swagger UI.

            Read more about it at the
            [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(root_path="/api/v1")
            ```
            """
        ),
    ] = "",
    root_path_in_servers: Annotated[
        bool,
        Doc(
            """
            To disable automatically generating the URLs in the `servers` field
            in the autogenerated OpenAPI using the `root_path`.

            Read more about it in the
            [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#disable-automatic-server-from-root-path).

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI(root_path_in_servers=False)
            ```
            """
        ),
    ] = True,
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses to be shown in OpenAPI.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).

            And in the
            [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            OpenAPI callbacks that should apply to all *path operations*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    webhooks: Annotated[
        routing.APIRouter | None,
        Doc(
            """
            Add OpenAPI webhooks. This is similar to `callbacks` but it doesn't
            depend on specific *path operations*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            **Note**: This is available since OpenAPI 3.1.0, FastAPI 0.99.0.

            Read more about it in the
            [FastAPI docs for OpenAPI Webhooks](https://fastapi.tiangolo.com/advanced/openapi-webhooks/).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark all *path operations* as deprecated. You probably don't need it,
            but it's available.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#deprecate-a-path-operation).
            """
        ),
    ] = None,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            To include (or not) all the *path operations* in the generated OpenAPI.
            You probably don't need it, but it's available.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    swagger_ui_parameters: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Parameters to configure Swagger UI, the autogenerated interactive API
            documentation (by default at `/docs`).

            Read more about it in the
            [FastAPI docs about how to Configure Swagger UI](https://fastapi.tiangolo.com/how-to/configure-swagger-ui/).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
    separate_input_output_schemas: Annotated[
        bool,
        Doc(
            """
            Whether to generate separate OpenAPI schemas for request body and
            response body when the results would be more precise.

            This is particularly useful when automatically generating clients.

            For example, if you have a model like:

            ```python
            from pydantic import BaseModel

            class Item(BaseModel):
                name: str
                tags: list[str] = []
            ```

            When `Item` is used for input, a request body, `tags` is not required,
            the client doesn't have to provide it.

            But when using `Item` for output, for a response body, `tags` is always
            available because it has a default value, even if it's just an empty
            list. So, the client should be able to always expect it.

            In this case, there would be two different schemas, one for input and
            another one for output.

            Read more about it in the
            [FastAPI docs about how to separate schemas for input and output](https://fastapi.tiangolo.com/how-to/separate-openapi-schemas)
            """
        ),
    ] = True,
    openapi_external_docs: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            This field allows you to provide additional external documentation links.
            If provided, it must be a dictionary containing:

            * `description`: A brief description of the external documentation.
            * `url`: The URL pointing to the external documentation. The value **MUST**
            be a valid URL format.

            **Example**:

            ```python
            from fastapi import FastAPI

            external_docs = {
                "description": "Detailed API Reference",
                "url": "https://example.com/api-docs",
            }

            app = FastAPI(openapi_external_docs=external_docs)
            ```
            """
        ),
    ] = None,
    strict_content_type: Annotated[
        bool,
        Doc(
            """
            Enable strict checking for request Content-Type headers.

            When `True` (the default), requests with a body that do not include
            a `Content-Type` header will **not** be parsed as JSON.

            This prevents potential cross-site request forgery (CSRF) attacks
            that exploit the browser's ability to send requests without a
            Content-Type header, bypassing CORS preflight checks. In particular
            applicable for apps that need to be run locally (in localhost).

            When `False`, requests without a `Content-Type` header will have
            their body parsed as JSON, which maintains compatibility with
            certain clients that don't send `Content-Type` headers.

            Read more about it in the
            [FastAPI docs for Strict Content-Type](https://fastapi.tiangolo.com/advanced/strict-content-type/).
            """
        ),
    ] = True,
    **extra: Annotated[
        Any,
        Doc(
            """
            Extra keyword arguments to be stored in the app, not used by FastAPI
            anywhere.
            """
        ),
    ],
) -> None:
    self.debug = debug
    self.title = title
    self.summary = summary
    self.description = description
    self.version = version
    self.terms_of_service = terms_of_service
    self.contact = contact
    self.license_info = license_info
    self.openapi_url = openapi_url
    self.openapi_tags = openapi_tags
    self.root_path_in_servers = root_path_in_servers
    self.docs_url = docs_url
    self.redoc_url = redoc_url
    self.swagger_ui_oauth2_redirect_url = swagger_ui_oauth2_redirect_url
    self.swagger_ui_init_oauth = swagger_ui_init_oauth
    self.swagger_ui_parameters = swagger_ui_parameters
    self.servers = servers or []
    self.separate_input_output_schemas = separate_input_output_schemas
    self.openapi_external_docs = openapi_external_docs
    self.extra = extra
    self.openapi_version: Annotated[
        str,
        Doc(
            """
            The version string of OpenAPI.

            FastAPI will generate OpenAPI version 3.1.0, and will output that as
            the OpenAPI version. But some tools, even though they might be
            compatible with OpenAPI 3.1.0, might not recognize it as a valid.

            So you could override this value to trick those tools into using
            the generated OpenAPI. Have in mind that this is a hack. But if you
            avoid using features added in OpenAPI 3.1.0, it might work for your
            use case.

            This is not passed as a parameter to the `FastAPI` class to avoid
            giving the false idea that FastAPI would generate a different OpenAPI
            schema. It is only available as an attribute.

            **Example**

            ```python
            from fastapi import FastAPI

            app = FastAPI()

            app.openapi_version = "3.0.2"
            ```
            """
        ),
    ] = "3.1.0"
    self.openapi_schema: dict[str, Any] | None = None
    self._openapi_routes_version: int | None = None
    if self.openapi_url:
        assert self.title, "A title must be provided for OpenAPI, e.g.: 'My API'"
        assert self.version, "A version must be provided for OpenAPI, e.g.: '2.1.0'"
    # TODO: remove when discarding the openapi_prefix parameter
    if openapi_prefix:
        logger.warning(
            '"openapi_prefix" has been deprecated in favor of "root_path", which '
            "follows more closely the ASGI standard, is simpler, and more "
            "automatic. Check the docs at "
            "https://fastapi.tiangolo.com/advanced/sub-applications/"
        )
    self.webhooks: Annotated[
        routing.APIRouter,
        Doc(
            """
            The `app.webhooks` attribute is an `APIRouter` with the *path
            operations* that will be used just for documentation of webhooks.

            Read more about it in the
            [FastAPI docs for OpenAPI Webhooks](https://fastapi.tiangolo.com/advanced/openapi-webhooks/).
            """
        ),
    ] = webhooks or routing.APIRouter()
    self.root_path = root_path or openapi_prefix
    self.state: Annotated[
        State,
        Doc(
            """
            A state object for the application. This is the same object for the
            entire application, it doesn't change from request to request.

            You normally wouldn't use this in FastAPI, for most of the cases you
            would instead use FastAPI dependencies.

            This is simply inherited from Starlette.

            Read more about it in the
            [Starlette docs for Applications](https://www.starlette.dev/applications/#storing-state-on-the-app-instance).
            """
        ),
    ] = State()
    self.dependency_overrides: Annotated[
        dict[Callable[..., Any], Callable[..., Any]],
        Doc(
            """
            A dictionary with overrides for the dependencies.

            Each key is the original dependency callable, and the value is the
            actual dependency that should be called.

            This is for testing, to replace expensive dependencies with testing
            versions.

            Read more about it in the
            [FastAPI docs for Testing Dependencies with Overrides](https://fastapi.tiangolo.com/advanced/testing-dependencies/).
            """
        ),
    ] = {}
    self.router: routing.APIRouter = routing.APIRouter(
        routes=routes,
        redirect_slashes=redirect_slashes,
        dependency_overrides_provider=self,
        on_startup=on_startup,
        on_shutdown=on_shutdown,
        lifespan=lifespan,
        default_response_class=default_response_class,
        dependencies=dependencies,
        callbacks=callbacks,
        deprecated=deprecated,
        include_in_schema=include_in_schema,
        responses=responses,
        generate_unique_id_function=generate_unique_id_function,
        strict_content_type=strict_content_type,
    )
    self.exception_handlers: dict[
        Any, Callable[[Request, Any], Response | Awaitable[Response]]
    ] = {} if exception_handlers is None else dict(exception_handlers)
    self.exception_handlers.setdefault(HTTPException, http_exception_handler)
    self.exception_handlers.setdefault(
        RequestValidationError, request_validation_exception_handler
    )

    # Starlette still has incorrect type specification for the handlers
    self.exception_handlers.setdefault(
        WebSocketRequestValidationError,
        websocket_request_validation_exception_handler,  # type: ignore[arg-type]
    )  # ty: ignore[no-matching-overload]

    self.user_middleware: list[Middleware] = (
        [] if middleware is None else list(middleware)
    )
    self.middleware_stack: ASGIApp | None = None
    self.setup()

openapi_version instance-attribute

openapi_version = '3.1.0'

La cadena de versión de OpenAPI.

FastAPI generará OpenAPI versión 3.1.0, y mostrará eso como la versión de OpenAPI. Pero algunas herramientas, aunque podrían ser compatibles con OpenAPI 3.1.0, podrían no reconocerlo como válido.

Así que podrías sobrescribir este valor para engañar a esas herramientas para que usen el OpenAPI generado. Ten en cuenta que esto es un truco. Pero si evitas usar características añadidas en OpenAPI 3.1.0, podría funcionar para tu caso de uso.

Esto no se pasa como parámetro a la clase FastAPI para evitar dar la falsa idea de que FastAPI generaría un esquema OpenAPI diferente. Solo está disponible como atributo.

Example

from fastapi import FastAPI

app = FastAPI()

app.openapi_version = "3.0.2"

webhooks instance-attribute

webhooks = webhooks or APIRouter()

El atributo app.webhooks es un APIRouter con las operaciones de ruta que serán usadas solo para documentación de webhooks.

Lee más sobre esto en la documentación de FastAPI para Webhooks de OpenAPI.

state instance-attribute

state = State()

Un objeto de estado para la aplicación. Este es el mismo objeto para toda la aplicación, no cambia de petición a petición.

Normalmente no usarías esto en FastAPI, para la mayoría de los casos en su lugar usarías dependencias de FastAPI.

Esto es simplemente heredado de Starlette.

Lee más sobre esto en la documentación de Starlette para Aplicaciones.

dependency_overrides instance-attribute

dependency_overrides = {}

Un diccionario con sobreescrituras para las dependencias.

Cada clave es el callable de dependencia original, y el valor es la dependencia actual que debería ser llamada.

Esto es para testing, para reemplazar dependencias costosas con versiones de testing.

Lee más sobre esto en la documentación de FastAPI para Testing de dependencias con sobreescrituras.

openapi

openapi()

Genera el esquema OpenAPI de la aplicación. Esto es llamado por FastAPI internamente.

La primera vez que se llama almacena el resultado en el atributo app.openapi_schema, y las siguientes veces que se llama, simplemente devuelve ese mismo resultado. Para evitar el coste de generar el esquema cada vez.

Si necesitas modificar el esquema OpenAPI generado, podrías modificarlo.

Lee más en la documentación de FastAPI para OpenAPI.

Código fuente en fastapi/applications.py
def openapi(self) -> dict[str, Any]:
    """
    Generate the OpenAPI schema of the application. This is called by FastAPI
    internally.

    The first time it is called it stores the result in the attribute
    `app.openapi_schema`, and next times it is called, it just returns that same
    result. To avoid the cost of generating the schema every time.

    If you need to modify the generated OpenAPI schema, you could modify it.

    Read more in the
    [FastAPI docs for OpenAPI](https://fastapi.tiangolo.com/how-to/extending-openapi/).
    """
    routes_version = self.router._get_routes_version()
    if not self.openapi_schema or self._openapi_routes_version != routes_version:
        self.openapi_schema = get_openapi(
            title=self.title,
            version=self.version,
            openapi_version=self.openapi_version,
            summary=self.summary,
            description=self.description,
            terms_of_service=self.terms_of_service,
            contact=self.contact,
            license_info=self.license_info,
            routes=self.routes,
            webhooks=self.webhooks.routes,
            tags=self.openapi_tags,
            servers=self.servers,
            separate_input_output_schemas=self.separate_input_output_schemas,
            external_docs=self.openapi_external_docs,
        )
        self._openapi_routes_version = routes_version
    return self.openapi_schema

websocket

websocket(path, name=None, *, dependencies=None)

Decora una función WebSocket.

Lee más sobre esto en la documentación de FastAPI para WebSockets.

Example

from fastapi import FastAPI, WebSocket

app = FastAPI()

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(f"Message text was: {data}")
PARÁMETRO DESCRIPCIÓN
path

Ruta del WebSocket.

TYPE: str

name

Un nombre para el WebSocket. Solo usado internamente.

TYPE: str | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para usar con este WebSocket.

Lee más sobre esto en la documentación de FastAPI para WebSockets.

TYPE: Sequence[Depends] | None DEFAULT: None

Código fuente en fastapi/applications.py
def websocket(
    self,
    path: Annotated[
        str,
        Doc(
            """
            WebSocket path.
            """
        ),
    ],
    name: Annotated[
        str | None,
        Doc(
            """
            A name for the WebSocket. Only used internally.
            """
        ),
    ] = None,
    *,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be used for this
            WebSocket.

            Read more about it in the
            [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).
            """
        ),
    ] = None,
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Decorate a WebSocket function.

    Read more about it in the
    [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).

    **Example**

    ```python
    from fastapi import FastAPI, WebSocket

    app = FastAPI()

    @app.websocket("/ws")
    async def websocket_endpoint(websocket: WebSocket):
        await websocket.accept()
        while True:
            data = await websocket.receive_text()
            await websocket.send_text(f"Message text was: {data}")
    ```
    """

    def decorator(func: DecoratedCallable) -> DecoratedCallable:
        self.add_api_websocket_route(
            path,
            func,
            name=name,
            dependencies=dependencies,
        )
        return func

    return decorator

include_router

include_router(
    router,
    *,
    prefix="",
    tags=None,
    dependencies=None,
    responses=None,
    deprecated=None,
    include_in_schema=True,
    default_response_class=Default(JSONResponse),
    callbacks=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Incluye un APIRouter en la misma aplicación.

Lee más sobre esto en la documentación de FastAPI para Aplicaciones Más Grandes.

Ejemplo
from fastapi import FastAPI

from .users import users_router

app = FastAPI()

app.include_router(users_router)
PARÁMETRO DESCRIPCIÓN
router

El APIRouter a incluir.

TYPE: APIRouter

prefix

Un prefijo de ruta opcional para el router.

TYPE: str DEFAULT: ''

tags

Una lista de etiquetas para aplicar a todas las path operations en este router.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a todas las path operations en este router.

Lee más sobre esto en la documentación de FastAPI para Aplicaciones Más Grandes - Múltiples Archivos.

Example

from fastapi import Depends, FastAPI

from .dependencies import get_token_header
from .internal import admin

app = FastAPI()

app.include_router(
    admin.router,
    dependencies=[Depends(get_token_header)],
)

TYPE: Sequence[Depends] | None DEFAULT: None

responses

Respuestas adicionales a mostrar en OpenAPI.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Respuestas Adicionales en OpenAPI.

Y en la documentación de FastAPI para Aplicaciones Más Grandes.

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca todas las operaciones de ruta en este router como deprecadas.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Example

from fastapi import FastAPI

from .internal import old_api

app = FastAPI()

app.include_router(
    old_api.router,
    deprecated=True,
)

TYPE: bool | None DEFAULT: None

include_in_schema

Incluir (o no) todas las path operations de este router en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Example

from fastapi import FastAPI

from .internal import old_api

app = FastAPI()

app.include_router(
    old_api.router,
    include_in_schema=False,
)

TYPE: bool DEFAULT: True

default_response_class

Clase de respuesta por defecto para ser usada en las operaciones de ruta en este router.

Lee más en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

Example

from fastapi import FastAPI
from fastapi.responses import ORJSONResponse

from .internal import old_api

app = FastAPI()

app.include_router(
    old_api.router,
    default_response_class=ORJSONResponse,
)

TYPE: type[Response] DEFAULT: Default(JSONResponse)

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def include_router(
    self,
    router: Annotated[routing.APIRouter, Doc("The `APIRouter` to include.")],
    *,
    prefix: Annotated[str, Doc("An optional path prefix for the router.")] = "",
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to all the *path operations* in this
            router.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to all the
            *path operations* in this router.

            Read more about it in the
            [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).

            **Example**

            ```python
            from fastapi import Depends, FastAPI

            from .dependencies import get_token_header
            from .internal import admin

            app = FastAPI()

            app.include_router(
                admin.router,
                dependencies=[Depends(get_token_header)],
            )
            ```
            """
        ),
    ] = None,
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses to be shown in OpenAPI.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).

            And in the
            [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark all the *path operations* in this router as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            **Example**

            ```python
            from fastapi import FastAPI

            from .internal import old_api

            app = FastAPI()

            app.include_router(
                old_api.router,
                deprecated=True,
            )
            ```
            """
        ),
    ] = None,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include (or not) all the *path operations* in this router in the
            generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            **Example**

            ```python
            from fastapi import FastAPI

            from .internal import old_api

            app = FastAPI()

            app.include_router(
                old_api.router,
                include_in_schema=False,
            )
            ```
            """
        ),
    ] = True,
    default_response_class: Annotated[
        type[Response],
        Doc(
            """
            Default response class to be used for the *path operations* in this
            router.

            Read more in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).

            **Example**

            ```python
            from fastapi import FastAPI
            from fastapi.responses import ORJSONResponse

            from .internal import old_api

            app = FastAPI()

            app.include_router(
                old_api.router,
                default_response_class=ORJSONResponse,
            )
            ```
            """
        ),
    ] = Default(JSONResponse),
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> None:
    """
    Include an `APIRouter` in the same app.

    Read more about it in the
    [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).

    ## Example

    ```python
    from fastapi import FastAPI

    from .users import users_router

    app = FastAPI()

    app.include_router(users_router)
    ```
    """
    self.router.include_router(
        router,
        prefix=prefix,
        tags=tags,
        dependencies=dependencies,
        responses=responses,
        deprecated=deprecated,
        include_in_schema=include_in_schema,
        default_response_class=default_response_class,
        callbacks=callbacks,
        generate_unique_id_function=generate_unique_id_function,
    )

frontend

frontend(
    path, *, directory, fallback="auto", check_dir=True
)

Sirve un build de frontend estático como rutas de baja prioridad.

Usa esto para herramientas de frontend que compilan archivos estáticos en un directorio, tal como dist. Las path operations de FastAPI se verifican primero, y los archivos del frontend se verifican solo si ninguna ruta normal coincidió.

Un proyecto típico podría verse así:

.
├── pyproject.toml
├── app
│   ├── __init__.py
│   └── main.py
└── dist
    ├── index.html
    └── assets
        └── app.js

Luego en app/main.py:

from fastapi import FastAPI

app = FastAPI()
app.frontend("/", directory="dist")
PARÁMETRO DESCRIPCIÓN
path

El prefijo de ruta URL donde el build del frontend debería ser servido.

TYPE: str

directory

El directorio que contiene la salida del build del frontend estático.

TYPE: str | PathLike[str]

fallback

El comportamiento de archivo fallback para las rutas del frontend que no existen.

TYPE: Literal['auto', 'index.html', '404.html'] | None DEFAULT: 'auto'

check_dir

Verifica que el directorio del frontend exista cuando se crea la app.

TYPE: bool DEFAULT: True

Código fuente en fastapi/applications.py
def frontend(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path prefix where the frontend build should be served.
            """
        ),
    ],
    *,
    directory: Annotated[
        str | os.PathLike[str],
        Doc(
            """
            The directory containing the static frontend build output.
            """
        ),
    ],
    fallback: Annotated[
        Literal["auto", "index.html", "404.html"] | None,
        Doc(
            """
            The fallback file behavior for missing frontend paths.
            """
        ),
    ] = "auto",
    check_dir: Annotated[
        bool,
        Doc(
            """
            Check that the frontend directory exists when the app is created.
            """
        ),
    ] = True,
) -> None:
    """
    Serve a static frontend build as low-priority routes.

    Use this for frontend tools that build static files into a directory,
    such as `dist`. **FastAPI** path operations are checked first, and
    the frontend files are checked only if no normal route matched.

    A typical project could look like this:

    ```text
    .
    ├── pyproject.toml
    ├── app
    │   ├── __init__.py
    │   └── main.py
    └── dist
        ├── index.html
        └── assets
            └── app.js
    ```

    Then in `app/main.py`:

    ```python
    from fastapi import FastAPI

    app = FastAPI()
    app.frontend("/", directory="dist")
    ```
    """
    self.router.frontend(
        path,
        directory=directory,
        fallback=fallback,
        check_dir=check_dir,
    )

get

get(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP GET.

Ejemplo
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_items():
    return [{"name": "Empanada"}, {"name": "Arepa"}]
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def get(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP GET operation.

    ## Example

    ```python
    from fastapi import FastAPI

    app = FastAPI()

    @app.get("/items/")
    def read_items():
        return [{"name": "Empanada"}, {"name": "Arepa"}]
    ```
    """
    return self.router.get(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

put

put(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP PUT.

Ejemplo
from fastapi import FastAPI
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str | None = None

app = FastAPI()

@app.put("/items/{item_id}")
def replace_item(item_id: str, item: Item):
    return {"message": "Item replaced", "id": item_id}
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def put(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP PUT operation.

    ## Example

    ```python
    from fastapi import FastAPI
    from pydantic import BaseModel

    class Item(BaseModel):
        name: str
        description: str | None = None

    app = FastAPI()

    @app.put("/items/{item_id}")
    def replace_item(item_id: str, item: Item):
        return {"message": "Item replaced", "id": item_id}
    ```
    """
    return self.router.put(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

post

post(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP POST.

Ejemplo
from fastapi import FastAPI
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str | None = None

app = FastAPI()

@app.post("/items/")
def create_item(item: Item):
    return {"message": "Item created"}
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def post(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP POST operation.

    ## Example

    ```python
    from fastapi import FastAPI
    from pydantic import BaseModel

    class Item(BaseModel):
        name: str
        description: str | None = None

    app = FastAPI()

    @app.post("/items/")
    def create_item(item: Item):
        return {"message": "Item created"}
    ```
    """
    return self.router.post(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

delete

delete(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP DELETE.

Ejemplo
from fastapi import FastAPI

app = FastAPI()

@app.delete("/items/{item_id}")
def delete_item(item_id: str):
    return {"message": "Item deleted"}
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def delete(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP DELETE operation.

    ## Example

    ```python
    from fastapi import FastAPI

    app = FastAPI()

    @app.delete("/items/{item_id}")
    def delete_item(item_id: str):
        return {"message": "Item deleted"}
    ```
    """
    return self.router.delete(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

options

options(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP OPTIONS.

Ejemplo
from fastapi import FastAPI

app = FastAPI()

@app.options("/items/")
def get_item_options():
    return {"additions": ["Aji", "Guacamole"]}
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def options(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP OPTIONS operation.

    ## Example

    ```python
    from fastapi import FastAPI

    app = FastAPI()

    @app.options("/items/")
    def get_item_options():
        return {"additions": ["Aji", "Guacamole"]}
    ```
    """
    return self.router.options(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

head

head(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP HEAD.

Ejemplo
from fastapi import FastAPI, Response

app = FastAPI()

@app.head("/items/", status_code=204)
def get_items_headers(response: Response):
    response.headers["X-Cat-Dog"] = "Alone in the world"
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def head(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP HEAD operation.

    ## Example

    ```python
    from fastapi import FastAPI, Response

    app = FastAPI()

    @app.head("/items/", status_code=204)
    def get_items_headers(response: Response):
        response.headers["X-Cat-Dog"] = "Alone in the world"
    ```
    """
    return self.router.head(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

patch

patch(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP PATCH.

Ejemplo
from fastapi import FastAPI
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str | None = None

app = FastAPI()

@app.patch("/items/")
def update_item(item: Item):
    return {"message": "Item updated in place"}
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def patch(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP PATCH operation.

    ## Example

    ```python
    from fastapi import FastAPI
    from pydantic import BaseModel

    class Item(BaseModel):
        name: str
        description: str | None = None

    app = FastAPI()

    @app.patch("/items/")
    def update_item(item: Item):
        return {"message": "Item updated in place"}
    ```
    """
    return self.router.patch(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

trace

trace(
    path,
    *,
    response_model=Default(None),
    status_code=None,
    tags=None,
    dependencies=None,
    summary=None,
    description=None,
    response_description="Successful Response",
    responses=None,
    deprecated=None,
    operation_id=None,
    response_model_include=None,
    response_model_exclude=None,
    response_model_by_alias=True,
    response_model_exclude_unset=False,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    include_in_schema=True,
    response_class=Default(JSONResponse),
    name=None,
    callbacks=None,
    openapi_extra=None,
    generate_unique_id_function=Default(generate_unique_id)
)

Añade una path operation usando una operación HTTP TRACE.

Ejemplo
from fastapi import FastAPI

app = FastAPI()

@app.trace("/items/{item_id}")
def trace_item(item_id: str):
    return None
PARÁMETRO DESCRIPCIÓN
path

La ruta URL a usar para esta path operation.

Por ejemplo, en http://example.com/items, la ruta es /items.

TYPE: str

response_model

El tipo a usar para la respuesta.

Podría ser cualquier tipo de field válido de Pydantic. Así que no tiene que ser un modelo de Pydantic, podría ser otras cosas, como un list, dict, etc.

Se usará para:

  • Documentación: el OpenAPI generado (y la UI en /docs) lo mostrará como la respuesta (JSON Schema).
  • Serialización: podrías devolver un objeto arbitrario y el response_model se usaría para serializar ese objeto en el JSON correspondiente.
  • Filtrado: el JSON enviado al cliente solo contendrá los datos (campos) definidos en el response_model. Si devolviste un objeto que contiene un atributo password pero el response_model no incluye ese campo, el JSON enviado al cliente no tendría ese password.
  • Validación: lo que devuelvas se serializará con el response_model, convirtiendo cualquier dato según sea necesario para generar el JSON correspondiente. Pero si los datos en el objeto devuelto no son válidos, eso significaría una violación del contrato con el cliente, así que es un error del desarrollador del API. Por lo tanto, FastAPI lanzará un error y devolverá un código de error 500 (Internal Server Error).

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta.

TYPE: Any DEFAULT: Default(None)

status_code

El código de estado por defecto a usar para la respuesta.

Puedes sobrescribir el código de estado devolviendo una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Código de Estado de Respuesta.

TYPE: int | None DEFAULT: None

tags

Una lista de etiquetas para aplicar a la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: list[str | Enum] | None DEFAULT: None

dependencies

Una lista de dependencias (usando Depends()) para aplicar a la path operation.

Lee más sobre esto en la documentación de FastAPI para Dependencias en decoradores de path operations.

TYPE: Sequence[Depends] | None DEFAULT: None

summary

Un resumen para la path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

description

Una descripción para la path operation.

Si no se proporciona, se extraerá automáticamente del docstring de la función path operation.

Puede contener Markdown.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Configuración de Path Operations.

TYPE: str | None DEFAULT: None

response_description

La descripción para la respuesta por defecto.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: str DEFAULT: 'Successful Response'

responses

Respuestas adicionales que podrían ser devueltas por esta path operation.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: dict[int | str, dict[str, Any]] | None DEFAULT: None

deprecated

Marca esta path operation como deprecada.

Se añadirá al OpenAPI generado (ej. visible en /docs).

TYPE: bool | None DEFAULT: None

operation_id

ID de operación personalizado para usar en esta path operation.

Por defecto, se genera automáticamente.

Si proporcionas un ID de operación personalizado, necesitas asegurarte de que sea único para toda el API.

Puedes personalizar la generación del ID de operación con el parámetro generate_unique_id_function en la clase FastAPI.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: str | None DEFAULT: None

response_model_include

Configuración pasada a Pydantic para incluir solo ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_exclude

Configuración pasada a Pydantic para excluir ciertos campos en los datos de respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: IncEx | None DEFAULT: None

response_model_by_alias

Configuración pasada a Pydantic para definir si el modelo de respuesta debe serializarse por alias cuando se usa un alias.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: True

response_model_exclude_unset

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que no fueron establecidos y tienen sus valores por defecto. Esto es diferente de response_model_exclude_defaults en que si los campos están establecidos, se incluirán en la respuesta, incluso si el valor es el mismo que el por defecto.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_defaults

Configuración pasada a Pydantic para definir si los datos de respuesta deberían tener todos los campos, incluyendo los que tienen el mismo valor que el por defecto. Esto es diferente de response_model_exclude_unset en que si los campos están establecidos pero contienen los mismos valores por defecto, se excluirán de la respuesta.

Cuando es True, los valores por defecto se omiten de la respuesta.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

response_model_exclude_none

Configuración pasada a Pydantic para definir si los datos de respuesta deberían excluir los campos establecidos como None.

Esto es mucho más simple (menos inteligente) que response_model_exclude_unset y response_model_exclude_defaults. Probablemente quieras usar uno de esos dos en lugar de este, ya que permiten devolver valores None cuando tiene sentido.

Lee más sobre esto en la documentación de FastAPI para Modelo de Respuesta - Tipo de Retorno.

TYPE: bool DEFAULT: False

include_in_schema

Incluye esta path operation en el esquema OpenAPI generado.

Esto afecta al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Parámetros de Consulta y Validaciones de Strings.

TYPE: bool DEFAULT: True

response_class

Clase de respuesta a usar para esta path operation.

Esto no se usará si devuelves una respuesta directamente.

Lee más sobre esto en la documentación de FastAPI para Respuestas Personalizadas - HTML, Stream, File, otras.

TYPE: type[Response] DEFAULT: Default(JSONResponse)

name

Nombre para esta path operation. Solo usado internamente.

TYPE: str | None DEFAULT: None

callbacks

Lista de path operations que se usarán como callbacks de OpenAPI.

Esto es solo para la documentación OpenAPI, los callbacks no se usarán directamente.

Se añadirá al OpenAPI generado (ej. visible en /docs).

Lee más sobre esto en la documentación de FastAPI para Callbacks de OpenAPI.

TYPE: list[BaseRoute] | None DEFAULT: None

openapi_extra

Metadatos extra para incluir en el esquema OpenAPI para esta path operation.

Lee más sobre esto en la documentación de FastAPI para Configuración Avanzada de Path Operations.

TYPE: dict[str, Any] | None DEFAULT: None

generate_unique_id_function

Personaliza la función usada para generar IDs únicos para las path operations mostradas en el OpenAPI generado.

Esto es particularmente útil cuando se generan automáticamente clientes o SDKs para tu API.

Lee más sobre esto en la documentación de FastAPI sobre cómo Generar Clientes.

TYPE: Callable[[APIRoute], str] DEFAULT: Default(generate_unique_id)

Código fuente en fastapi/applications.py
def trace(
    self,
    path: Annotated[
        str,
        Doc(
            """
            The URL path to be used for this *path operation*.

            For example, in `http://example.com/items`, the path is `/items`.
            """
        ),
    ],
    *,
    response_model: Annotated[
        Any,
        Doc(
            """
            The type to use for the response.

            It could be any valid Pydantic *field* type. So, it doesn't have to
            be a Pydantic model, it could be other things, like a `list`, `dict`,
            etc.

            It will be used for:

            * Documentation: the generated OpenAPI (and the UI at `/docs`) will
                show it as the response (JSON Schema).
            * Serialization: you could return an arbitrary object and the
                `response_model` would be used to serialize that object into the
                corresponding JSON.
            * Filtering: the JSON sent to the client will only contain the data
                (fields) defined in the `response_model`. If you returned an object
                that contains an attribute `password` but the `response_model` does
                not include that field, the JSON sent to the client would not have
                that `password`.
            * Validation: whatever you return will be serialized with the
                `response_model`, converting any data as necessary to generate the
                corresponding JSON. But if the data in the object returned is not
                valid, that would mean a violation of the contract with the client,
                so it's an error from the API developer. So, FastAPI will raise an
                error and return a 500 error code (Internal Server Error).

            Read more about it in the
            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
            """
        ),
    ] = Default(None),
    status_code: Annotated[
        int | None,
        Doc(
            """
            The default status code to be used for the response.

            You could override the status code by returning a response directly.

            Read more about it in the
            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
            """
        ),
    ] = None,
    tags: Annotated[
        list[str | Enum] | None,
        Doc(
            """
            A list of tags to be applied to the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
            """
        ),
    ] = None,
    dependencies: Annotated[
        Sequence[Depends] | None,
        Doc(
            """
            A list of dependencies (using `Depends()`) to be applied to the
            *path operation*.

            Read more about it in the
            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
            """
        ),
    ] = None,
    summary: Annotated[
        str | None,
        Doc(
            """
            A summary for the *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            A description for the *path operation*.

            If not provided, it will be extracted automatically from the docstring
            of the *path operation function*.

            It can contain Markdown.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
            """
        ),
    ] = None,
    response_description: Annotated[
        str,
        Doc(
            """
            The description for the default response.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = "Successful Response",
    responses: Annotated[
        dict[int | str, dict[str, Any]] | None,
        Doc(
            """
            Additional responses that could be returned by this *path operation*.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    deprecated: Annotated[
        bool | None,
        Doc(
            """
            Mark this *path operation* as deprecated.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = None,
    operation_id: Annotated[
        str | None,
        Doc(
            """
            Custom operation ID to be used by this *path operation*.

            By default, it is generated automatically.

            If you provide a custom operation ID, you need to make sure it is
            unique for the whole API.

            You can customize the
            operation ID generation with the parameter
            `generate_unique_id_function` in the `FastAPI` class.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = None,
    response_model_include: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to include only certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_exclude: Annotated[
        IncEx | None,
        Doc(
            """
            Configuration passed to Pydantic to exclude certain fields in the
            response data.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = None,
    response_model_by_alias: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response model
            should be serialized by alias when an alias is used.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
            """
        ),
    ] = True,
    response_model_exclude_unset: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that were not set and
            have their default values. This is different from
            `response_model_exclude_defaults` in that if the fields are set,
            they will be included in the response, even if the value is the same
            as the default.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_defaults: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data
            should have all the fields, including the ones that have the same value
            as the default. This is different from `response_model_exclude_unset`
            in that if the fields are set but contain the same default values,
            they will be excluded from the response.

            When `True`, default values are omitted from the response.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
            """
        ),
    ] = False,
    response_model_exclude_none: Annotated[
        bool,
        Doc(
            """
            Configuration passed to Pydantic to define if the response data should
            exclude fields set to `None`.

            This is much simpler (less smart) than `response_model_exclude_unset`
            and `response_model_exclude_defaults`. You probably want to use one of
            those two instead of this one, as those allow returning `None` values
            when it makes sense.

            Read more about it in the
            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
            """
        ),
    ] = False,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            Include this *path operation* in the generated OpenAPI schema.

            This affects the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
            """
        ),
    ] = True,
    response_class: Annotated[
        type[Response],
        Doc(
            """
            Response class to be used for this *path operation*.

            This will not be used if you return a response directly.

            Read more about it in the
            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
            """
        ),
    ] = Default(JSONResponse),
    name: Annotated[
        str | None,
        Doc(
            """
            Name for this *path operation*. Only used internally.
            """
        ),
    ] = None,
    callbacks: Annotated[
        list[BaseRoute] | None,
        Doc(
            """
            List of *path operations* that will be used as OpenAPI callbacks.

            This is only for OpenAPI documentation, the callbacks won't be used
            directly.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Read more about it in the
            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
            """
        ),
    ] = None,
    openapi_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Extra metadata to be included in the OpenAPI schema for this *path
            operation*.

            Read more about it in the
            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
            """
        ),
    ] = None,
    generate_unique_id_function: Annotated[
        Callable[[routing.APIRoute], str],
        Doc(
            """
            Customize the function used to generate unique IDs for the *path
            operations* shown in the generated OpenAPI.

            This is particularly useful when automatically generating clients or
            SDKs for your API.

            Read more about it in the
            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
            """
        ),
    ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a *path operation* using an HTTP TRACE operation.

    ## Example

    ```python
    from fastapi import FastAPI

    app = FastAPI()

    @app.trace("/items/{item_id}")
    def trace_item(item_id: str):
        return None
    ```
    """
    return self.router.trace(
        path,
        response_model=response_model,
        status_code=status_code,
        tags=tags,
        dependencies=dependencies,
        summary=summary,
        description=description,
        response_description=response_description,
        responses=responses,
        deprecated=deprecated,
        operation_id=operation_id,
        response_model_include=response_model_include,
        response_model_exclude=response_model_exclude,
        response_model_by_alias=response_model_by_alias,
        response_model_exclude_unset=response_model_exclude_unset,
        response_model_exclude_defaults=response_model_exclude_defaults,
        response_model_exclude_none=response_model_exclude_none,
        include_in_schema=include_in_schema,
        response_class=response_class,
        name=name,
        callbacks=callbacks,
        openapi_extra=openapi_extra,
        generate_unique_id_function=generate_unique_id_function,
    )

on_event

on_event(event_type)

Agrega un manejador de eventos para la aplicación.

on_event está deprecado, usa los manejadores de eventos lifespan en su lugar.

Lee más sobre esto en la documentación de FastAPI para Eventos de Lifespan.

PARÁMETRO DESCRIPCIÓN
event_type

El tipo de evento. startup o shutdown.

TYPE: str

Código fuente en fastapi/applications.py
@deprecated(
    """
    on_event is deprecated, use lifespan event handlers instead.

    Read more about it in the
    [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).
    """
)
def on_event(
    self,
    event_type: Annotated[
        str,
        Doc(
            """
            The type of event. `startup` or `shutdown`.
            """
        ),
    ],
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add an event handler for the application.

    `on_event` is deprecated, use `lifespan` event handlers instead.

    Read more about it in the
    [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).
    """
    return self.router.on_event(event_type)  # ty: ignore[deprecated]

middleware

middleware(middleware_type)

Agrega un middleware a la aplicación.

Lee más sobre esto en la documentación de FastAPI para Middleware.

Ejemplo
import time
from typing import Awaitable, Callable

from fastapi import FastAPI, Request, Response

app = FastAPI()


@app.middleware("http")
async def add_process_time_header(
    request: Request, call_next: Callable[[Request], Awaitable[Response]]
) -> Response:
    start_time = time.time()
    response = await call_next(request)
    process_time = time.time() - start_time
    response.headers["X-Process-Time"] = str(process_time)
    return response
PARÁMETRO DESCRIPCIÓN
middleware_type

El tipo de middleware. Actualmente solo soporta http.

TYPE: str

Código fuente en fastapi/applications.py
def middleware(
    self,
    middleware_type: Annotated[
        str,
        Doc(
            """
            The type of middleware. Currently only supports `http`.
            """
        ),
    ],
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add a middleware to the application.

    Read more about it in the
    [FastAPI docs for Middleware](https://fastapi.tiangolo.com/tutorial/middleware/).

    ## Example

    ```python
    import time
    from typing import Awaitable, Callable

    from fastapi import FastAPI, Request, Response

    app = FastAPI()


    @app.middleware("http")
    async def add_process_time_header(
        request: Request, call_next: Callable[[Request], Awaitable[Response]]
    ) -> Response:
        start_time = time.time()
        response = await call_next(request)
        process_time = time.time() - start_time
        response.headers["X-Process-Time"] = str(process_time)
        return response
    ```
    """

    def decorator(func: DecoratedCallable) -> DecoratedCallable:
        self.add_middleware(BaseHTTPMiddleware, dispatch=func)
        return func

    return decorator

exception_handler

exception_handler(exc_class_or_status_code)

Agrega un manejador de excepciones a la aplicación.

Lee más sobre esto en la documentación de FastAPI para Manejo de errores.

Ejemplo
from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse


class UnicornException(Exception):
    def __init__(self, name: str):
        self.name = name


app = FastAPI()


@app.exception_handler(UnicornException)
async def unicorn_exception_handler(request: Request, exc: UnicornException):
    return JSONResponse(
        status_code=418,
        content={"message": f"Oops! {exc.name} did something. There goes a rainbow..."},
    )
PARÁMETRO DESCRIPCIÓN
exc_class_or_status_code

La clase de Excepción que esto manejaría, o un código de estado.

TIPO: int | type[Exception]

Código fuente en fastapi/applications.py
def exception_handler(
    self,
    exc_class_or_status_code: Annotated[
        int | type[Exception],
        Doc(
            """
            The Exception class this would handle, or a status code.
            """
        ),
    ],
) -> Callable[[DecoratedCallable], DecoratedCallable]:
    """
    Add an exception handler to the app.

    Read more about it in the
    [FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/).

    ## Example

    ```python
    from fastapi import FastAPI, Request
    from fastapi.responses import JSONResponse


    class UnicornException(Exception):
        def __init__(self, name: str):
            self.name = name


    app = FastAPI()


    @app.exception_handler(UnicornException)
    async def unicorn_exception_handler(request: Request, exc: UnicornException):
        return JSONResponse(
            status_code=418,
            content={"message": f"Oops! {exc.name} did something. There goes a rainbow..."},
        )
    ```
    """

    def decorator(func: DecoratedCallable) -> DecoratedCallable:
        self.add_exception_handler(exc_class_or_status_code, func)
        return func

    return decorator