mirror of
https://github.com/fastapi/fastapi.git
synced 2026-09-15 06:53:16 -04:00
🌐 Update translations for es (update-outdated) (#15892)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Yurii Motov <yurii.motov.monte@gmail.com>
This commit is contained in:
60 files changed
+217
-187
No files matched your search
@@ -17,16 +17,16 @@ Digamos que tienes una estructura de archivos como esta:
|
||||
```
|
||||
.
|
||||
├── app
|
||||
│ ├── __init__.py
|
||||
│ ├── main.py
|
||||
│ ├── dependencies.py
|
||||
│ └── routers
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── items.py
|
||||
│ │ └── users.py
|
||||
│ └── internal
|
||||
│ ├── __init__.py
|
||||
│ └── admin.py
|
||||
│ ├── __init__.py
|
||||
│ ├── main.py
|
||||
│ ├── dependencies.py
|
||||
│ └── routers
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── items.py
|
||||
│ │ └── users.py
|
||||
│ └── internal
|
||||
│ ├── __init__.py
|
||||
│ └── admin.py
|
||||
```
|
||||
|
||||
/// tip | Consejo
|
||||
@@ -181,12 +181,12 @@ El resultado final es que los paths de item son ahora:
|
||||
...como pretendíamos.
|
||||
|
||||
* Serán marcados con una lista de tags que contiene un solo string `"items"`.
|
||||
* Estos "tags" son especialmente útiles para los sistemas de documentación interactiva automática (usando OpenAPI).
|
||||
* Estos "tags" son especialmente útiles para los sistemas de documentación interactiva automática (usando OpenAPI).
|
||||
* Todos incluirán las `responses` predefinidas.
|
||||
* Todas estas *path operations* tendrán la lista de `dependencies` evaluadas/ejecutadas antes de ellas.
|
||||
* Si también declaras dependencias en una *path operation* específica, **también se ejecutarán**.
|
||||
* Las dependencias del router se ejecutan primero, luego las [`dependencies` en el decorador](dependencies/dependencies-in-path-operation-decorators.md), y luego las dependencias de parámetros normales.
|
||||
* También puedes agregar [dependencias de `Security` con `scopes`](../advanced/security/oauth2-scopes.md).
|
||||
* Si también declaras dependencias en una *path operation* específica, **también se ejecutarán**.
|
||||
* Las dependencias del router se ejecutan primero, luego las [`dependencies` en el decorador](dependencies/dependencies-in-path-operation-decorators.md), y luego las dependencias de parámetros normales.
|
||||
* También puedes agregar [dependencias de `Security` con `scopes`](../advanced/security/oauth2-scopes.md).
|
||||
|
||||
/// tip | Consejo
|
||||
|
||||
@@ -461,7 +461,7 @@ Los `APIRouter`s no están "montados", no están aislados del resto de la aplica
|
||||
|
||||
Esto se debe a que queremos incluir sus *path operations* en el esquema de OpenAPI y las interfaces de usuario.
|
||||
|
||||
FastAPI mantiene los routers y *path operations* originales activos, y combina los prefijos del router, dependencias, tags, responses y otros metadatos al manejar requests y generar OpenAPI.
|
||||
FastAPI mantiene los routers y path operations originales activos, y combina los prefijos del router, dependencias, tags, responses y otros metadatos al manejar requests y generar OpenAPI.
|
||||
|
||||
///
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ pasa el/los tipo(s) interno(s) como "parámetros de tipo" usando corchetes: `[`
|
||||
my_list: list[str]
|
||||
```
|
||||
|
||||
Eso es toda la sintaxis estándar de Python para declaraciones de tipo.
|
||||
Esa es toda la sintaxis estándar de Python para declaraciones de tipo.
|
||||
|
||||
Usa esa misma sintaxis estándar para atributos de modelos con tipos internos.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# Request Body { #request-body }
|
||||
|
||||
|
||||
Cuando necesitas enviar datos desde un cliente (digamos, un navegador) a tu API, los envías como un **request body**.
|
||||
|
||||
Un **request** body es un dato enviado por el cliente a tu API. Un **response** body es el dato que tu API envía al cliente.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# Depuración { #debugging }
|
||||
|
||||
|
||||
Puedes conectar el depurador en tu editor, por ejemplo con Visual Studio Code o PyCharm.
|
||||
|
||||
## Llama a `uvicorn` { #call-uvicorn }
|
||||
|
||||
@@ -234,6 +234,7 @@ participant operation as Path Operation
|
||||
Las dependencias con `yield` han evolucionado con el tiempo para cubrir diferentes casos de uso y corregir algunos problemas.
|
||||
|
||||
Si quieres ver qué ha cambiado en diferentes versiones de FastAPI, puedes leer más al respecto en la guía avanzada, en [Dependencias avanzadas - Dependencias con `yield`, `HTTPException`, `except` y Tareas en Background](../../advanced/advanced-dependencies.md#dependencies-with-yield-httpexception-except-and-background-tasks).
|
||||
|
||||
## Context Managers { #context-managers }
|
||||
|
||||
### Qué son los "Context Managers" { #what-are-context-managers }
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# Tipos de Datos Extra { #extra-data-types }
|
||||
|
||||
|
||||
Hasta ahora, has estado usando tipos de datos comunes, como:
|
||||
|
||||
* `int`
|
||||
|
||||
@@ -208,4 +208,4 @@ En este caso, puedes usar `dict`:
|
||||
|
||||
Usa múltiples modelos Pydantic y hereda libremente para cada caso.
|
||||
|
||||
No necesitas tener un solo modelo de datos por entidad si esa entidad debe poder tener diferentes "estados". Como el caso con la "entidad" usuario con un estado que incluye `password`, `password_hash` y sin contraseña.
|
||||
No necesitas tener un solo modelo de datos por entidad si esa entidad debe poder tener diferentes "estados". La "entidad" **usuario** es un ejemplo, con estados que incluyen `password`, `password_hash` o ninguna contraseña.
|
||||
@@ -90,13 +90,13 @@ Verás la documentación alternativa automática (proporcionada por [ReDoc](http
|
||||
|
||||
Un "esquema" es una definición o descripción de algo. No el código que lo implementa, sino solo una descripción abstracta.
|
||||
|
||||
#### Esquema de la API { #api-schema }
|
||||
#### "Esquema" de la API { #api-schema }
|
||||
|
||||
En este caso, [OpenAPI](https://github.com/OAI/OpenAPI-Specification) es una especificación que dicta cómo definir un esquema de tu API.
|
||||
|
||||
Esta definición de esquema incluye los paths de tu API, los posibles parámetros que toman, etc.
|
||||
|
||||
#### Esquema de Datos { #data-schema }
|
||||
#### "Esquema" de datos { #data-schema }
|
||||
|
||||
El término "esquema" también podría referirse a la forma de algunos datos, como el contenido JSON.
|
||||
|
||||
@@ -194,7 +194,7 @@ O, también puedes pasar la opción `--entrypoint` al comando `fastapi dev`:
|
||||
$ fastapi dev --entrypoint main:app
|
||||
```
|
||||
|
||||
Pero tendrías que recordar pasar el path o entrypoint correctos cada vez que llames al comando `fastapi`.
|
||||
Pero tendrías que recordar pasar el path\entrypoint correcto cada vez que llames al comando `fastapi`.
|
||||
|
||||
Además, otras herramientas podrían no ser capaces de encontrarlo, por ejemplo la [Extensión de VS Code](../editor-support.md) o [FastAPI Cloud](https://fastapicloud.com), así que se recomienda usar el `entrypoint` en `pyproject.toml`.
|
||||
|
||||
@@ -301,7 +301,7 @@ Normalmente usas:
|
||||
* `PUT`: para actualizar datos.
|
||||
* `DELETE`: para eliminar datos.
|
||||
|
||||
Así que, en OpenAPI, cada uno de los métodos HTTP se llama una "operation".
|
||||
Así que, en OpenAPI, cada uno de los métodos HTTP se llama una "operación".
|
||||
|
||||
Vamos a llamarlas "**operaciones**" también.
|
||||
|
||||
|
||||
@@ -101,7 +101,7 @@ Así que recibirás un error limpio, con un código de estado HTTP de `418` y un
|
||||
{"message": "Oops! yolo did something. There goes a rainbow..."}
|
||||
```
|
||||
|
||||
/// note | Nota Técnica
|
||||
/// note | Detalles Técnicos
|
||||
|
||||
También podrías usar `from starlette.requests import Request` y `from starlette.responses import JSONResponse`.
|
||||
|
||||
@@ -109,11 +109,11 @@ También podrías usar `from starlette.requests import Request` y `from starlett
|
||||
|
||||
///
|
||||
|
||||
## Sobrescribir los manejadores de excepciones predeterminados { #override-the-default-exception-handlers }
|
||||
## Sobrescribir los manejadores de excepciones por defecto { #override-the-default-exception-handlers }
|
||||
|
||||
**FastAPI** tiene algunos manejadores de excepciones predeterminados.
|
||||
**FastAPI** tiene algunos manejadores de excepciones por defecto.
|
||||
|
||||
Estos manejadores se encargan de devolver los responses JSON predeterminadas cuando lanzas un `HTTPException` y cuando el request tiene datos inválidos.
|
||||
Estos manejadores se encargan de devolver los responses JSON por defecto cuando lanzas un `HTTPException` y cuando el request tiene datos inválidos.
|
||||
|
||||
Puedes sobrescribir estos manejadores de excepciones con los tuyos propios.
|
||||
|
||||
@@ -121,7 +121,7 @@ Puedes sobrescribir estos manejadores de excepciones con los tuyos propios.
|
||||
|
||||
Cuando un request contiene datos inválidos, **FastAPI** lanza internamente un `RequestValidationError`.
|
||||
|
||||
Y también incluye un manejador de excepciones predeterminado para ello.
|
||||
Y también incluye un manejador de excepciones por defecto para ello.
|
||||
|
||||
Para sobrescribirlo, importa el `RequestValidationError` y úsalo con `@app.exception_handler(RequestValidationError)` para decorar el manejador de excepciones.
|
||||
|
||||
@@ -161,7 +161,7 @@ Por ejemplo, podrías querer devolver un response de texto plano en lugar de JSO
|
||||
|
||||
{* ../../docs_src/handling_errors/tutorial004_py310.py hl[3:4,9:11,25] *}
|
||||
|
||||
/// note | Nota Técnica
|
||||
/// note | Detalles Técnicos
|
||||
|
||||
También podrías usar `from starlette.responses import PlainTextResponse`.
|
||||
|
||||
@@ -237,8 +237,8 @@ from starlette.exceptions import HTTPException as StarletteHTTPException
|
||||
|
||||
### Reutilizar los manejadores de excepciones de **FastAPI** { #reuse-fastapis-exception-handlers }
|
||||
|
||||
Si quieres usar la excepción junto con los mismos manejadores de excepciones predeterminados de **FastAPI**, puedes importar y reutilizar los manejadores de excepciones predeterminados de `fastapi.exception_handlers`:
|
||||
Si quieres usar la excepción junto con los mismos manejadores de excepciones por defecto de **FastAPI**, puedes importar y reutilizar los manejadores de excepciones por defecto de `fastapi.exception_handlers`:
|
||||
|
||||
{* ../../docs_src/handling_errors/tutorial006_py310.py hl[2:5,15,21] *}
|
||||
|
||||
En este ejemplo solo estás `print`eando el error con un mensaje muy expresivo, pero te haces una idea. Puedes usar la excepción y luego simplemente reutilizar los manejadores de excepciones predeterminados.
|
||||
En este ejemplo solo estás `print`eando el error con un mensaje muy expresivo, pero te haces una idea. Puedes usar la excepción y luego simplemente reutilizar los manejadores de excepciones por defecto.
|
||||
@@ -54,7 +54,7 @@ $ <font color="#4E9A06">fastapi</font> dev
|
||||
|
||||
Es **ALTAMENTE recomendable** que escribas o copies el código, lo edites y lo ejecutes localmente.
|
||||
|
||||
Usarlo en tu editor es lo que realmente te muestra los beneficios de FastAPI, al ver cuán poco código tienes que escribir, todos los chequeos de tipos, autocompletado, etc.
|
||||
Usarlo en tu editor es lo que realmente te muestra los beneficios de FastAPI, al ver cuán poco código tienes que escribir, todo el chequeo de tipos, autocompletado, etc.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Metadata y URLs de Docs { #metadata-and-docs-urls }
|
||||
# Metadata y URLs de documentación { #metadata-and-docs-urls }
|
||||
|
||||
Puedes personalizar varias configuraciones de metadata en tu aplicación **FastAPI**.
|
||||
|
||||
@@ -11,7 +11,7 @@ Puedes establecer los siguientes campos que se usan en la especificación OpenAP
|
||||
| `title` | `str` | El título de la API. |
|
||||
| `summary` | `str` | Un resumen corto de la API. <small>Disponible desde OpenAPI 3.1.0, FastAPI 0.99.0.</small> |
|
||||
| `description` | `str` | Una breve descripción de la API. Puede usar Markdown. |
|
||||
| `version` | `string` | La versión de la API. Esta es la versión de tu propia aplicación, no de OpenAPI. Por ejemplo, `2.5.0`. |
|
||||
| `version` | `str` | La versión de la API. Esta es la versión de tu propia aplicación, no de OpenAPI. Por ejemplo, `2.5.0`. |
|
||||
| `terms_of_service` | `str` | Una URL a los Términos de Servicio para la API. Si se proporciona, debe ser una URL. |
|
||||
| `contact` | `dict` | La información de contacto para la API expuesta. Puede contener varios campos. <details><summary><code>contact</code> fields</summary><table><thead><tr><th>Parámetro</th><th>Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>str</code></td><td>El nombre identificativo de la persona/organización de contacto.</td></tr><tr><td><code>url</code></td><td><code>str</code></td><td>La URL que apunta a la información de contacto. DEBE tener el formato de una URL.</td></tr><tr><td><code>email</code></td><td><code>str</code></td><td>La dirección de correo electrónico de la persona/organización de contacto. DEBE tener el formato de una dirección de correo.</td></tr></tbody></table></details> |
|
||||
| `license_info` | `dict` | La información de la licencia para la API expuesta. Puede contener varios campos. <details><summary><code>license_info</code> fields</summary><table><thead><tr><th>Parámetro</th><th>Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>str</code></td><td><strong>REQUERIDO</strong> (si se establece un <code>license_info</code>). El nombre de la licencia utilizada para la API.</td></tr><tr><td><code>identifier</code></td><td><code>str</code></td><td>Una expresión de licencia [SPDX](https://spdx.org/licenses/) para la API. El campo <code>identifier</code> es mutuamente excluyente del campo <code>url</code>. <small>Disponible desde OpenAPI 3.1.0, FastAPI 0.99.0.</small></td></tr><tr><td><code>url</code></td><td><code>str</code></td><td>Una URL a la licencia utilizada para la API. DEBE tener el formato de una URL.</td></tr></tbody></table></details> |
|
||||
@@ -104,7 +104,7 @@ Por ejemplo, para configurarlo para que se sirva en `/api/v1/openapi.json`:
|
||||
|
||||
Si quieres deshabilitar el esquema OpenAPI completamente, puedes establecer `openapi_url=None`, eso también deshabilitará las interfaces de usuario de documentación que lo usan.
|
||||
|
||||
## URLs de Docs { #docs-urls }
|
||||
## URLs de documentación { #docs-urls }
|
||||
|
||||
Puedes configurar las dos interfaces de usuario de documentación incluidas:
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ Puedes añadir un `summary` y `description`:
|
||||
|
||||
## Descripción desde docstring { #description-from-docstring }
|
||||
|
||||
Como las descripciones tienden a ser largas y cubrir múltiples líneas, puedes declarar la descripción de la *path operation* en la <dfn title="un string de múltiples líneas como la primera expresión dentro de una función (no asignada a ninguna variable) usada para documentación">docstring</dfn> de la función y **FastAPI** la leerá desde allí.
|
||||
Como las descripciones tienden a ser largas y cubrir múltiples líneas, puedes declarar la descripción de la *path operation* en la <dfn title="un string de múltiples líneas como la primera expresión dentro de una función (no asignada a ninguna variable) usado para documentación">docstring</dfn> de la función y **FastAPI** la leerá desde allí.
|
||||
|
||||
Puedes escribir [Markdown](https://en.wikipedia.org/wiki/Markdown) en el docstring, se interpretará y mostrará correctamente (teniendo en cuenta la indentación del docstring).
|
||||
|
||||
@@ -90,11 +90,11 @@ Entonces, si no proporcionas una, **FastAPI** generará automáticamente una de
|
||||
|
||||
## Deprecar una *path operation* { #deprecate-a-path-operation }
|
||||
|
||||
Si necesitas marcar una *path operation* como <dfn title="obsoleta, se recomienda no usarla">deprecated</dfn>, pero sin eliminarla, pasa el parámetro `deprecated`:
|
||||
Si necesitas marcar una *path operation* como <dfn title="obsoleta, se recomienda no usarla">obsoleta</dfn>, pero sin eliminarla, pasa el parámetro `deprecated`:
|
||||
|
||||
{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *}
|
||||
|
||||
Se marcará claramente como deprecado en la documentación interactiva:
|
||||
Se marcará claramente como deprecated en la documentación interactiva:
|
||||
|
||||
<img src="/img/tutorial/path-operation-configuration/image04.png">
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ Tener `str | None` permitirá que tu editor te dé un mejor soporte y detecte er
|
||||
|
||||
## Validaciones adicionales { #additional-validation }
|
||||
|
||||
Vamos a hacer que, aunque `q` sea opcional, siempre que se proporcione, su longitud no exceda los 50 caracteres.
|
||||
Vamos a hacer que, aunque `q` sea opcional, siempre que se proporcione, **su longitud no exceda los 50 caracteres**.
|
||||
|
||||
### Importar `Query` y `Annotated` { #import-query-and-annotated }
|
||||
|
||||
@@ -69,7 +69,7 @@ Ahora que tenemos este `Annotated` donde podemos poner más información (en est
|
||||
|
||||
Nota que el valor por defecto sigue siendo `None`, por lo que el parámetro sigue siendo opcional.
|
||||
|
||||
Pero ahora, al tener `Query(max_length=50)` dentro de `Annotated`, le estamos diciendo a FastAPI que queremos que tenga validación adicional para este valor, queremos que tenga un máximo de 50 caracteres. 😎
|
||||
Pero ahora, al tener `Query(max_length=50)` dentro de `Annotated`, le estamos diciendo a FastAPI que queremos que tenga **validación adicional** para este valor, queremos que tenga un máximo de 50 caracteres. 😎
|
||||
|
||||
/// tip | Consejo
|
||||
|
||||
@@ -79,9 +79,9 @@ Aquí estamos usando `Query()` porque este es un **parámetro de query**. Más a
|
||||
|
||||
FastAPI ahora:
|
||||
|
||||
* Validará los datos asegurándose de que la longitud máxima sea de 50 caracteres
|
||||
* Mostrará un error claro para el cliente cuando los datos no sean válidos
|
||||
* Documentará el parámetro en el OpenAPI esquema *path operation* (así aparecerá en la UI de documentación automática)
|
||||
* **Validará** los datos asegurándose de que la longitud máxima sea de 50 caracteres
|
||||
* Mostrará un **error claro** para el cliente cuando los datos no sean válidos
|
||||
* **Documentará** el parámetro en el esquema de OpenAPI *path operation* (así aparecerá en la **UI de documentación automática**)
|
||||
|
||||
## Alternativa (antigua): `Query` como valor por defecto { #alternative-old-query-as-the-default-value }
|
||||
|
||||
@@ -120,7 +120,7 @@ Luego, podemos pasar más parámetros a `Query`. En este caso, el parámetro `ma
|
||||
q: str | None = Query(default=None, max_length=50)
|
||||
```
|
||||
|
||||
Esto validará los datos, mostrará un error claro cuando los datos no sean válidos, y documentará el parámetro en el esquema del *path operation* de OpenAPI.
|
||||
Esto validará los datos, mostrará un error claro cuando los datos no sean válidos, y documentará el parámetro en el esquema de OpenAPI *path operation*.
|
||||
|
||||
### `Query` como valor por defecto o en `Annotated` { #query-as-the-default-value-or-in-annotated }
|
||||
|
||||
@@ -150,13 +150,13 @@ q: str = Query(default="rick")
|
||||
|
||||
### Ventajas de `Annotated` { #advantages-of-annotated }
|
||||
|
||||
Usar `Annotated` es recomendado en lugar del valor por defecto en los parámetros de función, es mejor por múltiples razones. 🤓
|
||||
**Usar `Annotated` es recomendado** en lugar del valor por defecto en los parámetros de función, es **mejor** por múltiples razones. 🤓
|
||||
|
||||
El valor por defecto del parámetro de función es el valor real por defecto, eso es más intuitivo con Python en general. 😌
|
||||
El valor **por defecto** del **parámetro de función** es el **valor real por defecto**, eso es más intuitivo con Python en general. 😌
|
||||
|
||||
Podrías llamar a esa misma función en otros lugares sin FastAPI, y funcionaría como se espera. Si hay un parámetro requerido (sin un valor por defecto), tu editor te avisará con un error, Python también se quejará si lo ejecutas sin pasar el parámetro requerido.
|
||||
Podrías **llamar** a esa misma función en **otros lugares** sin FastAPI, y **funcionaría como se espera**. Si hay un parámetro **requerido** (sin un valor por defecto), tu **editor** te avisará con un error, **Python** también se quejará si lo ejecutas sin pasar el parámetro requerido.
|
||||
|
||||
Cuando no usas `Annotated` y en su lugar usas el estilo de valor por defecto (antiguo), si llamas a esa función sin FastAPI en otros lugares, tienes que recordar pasar los argumentos a la función para que funcione correctamente, de lo contrario, los valores serán diferentes de lo que esperas (por ejemplo, `QueryInfo` o algo similar en lugar de `str`). Y tu editor no se quejará, y Python no se quejará al ejecutar esa función, solo cuando los errores dentro de las operaciones hagan que funcione incorrectamente.
|
||||
Cuando no usas `Annotated` y en su lugar usas el **estilo de valor por defecto (antiguo)**, si llamas a esa función sin FastAPI en **otros lugares**, tienes que **recordar** pasar los argumentos a la función para que funcione correctamente, de lo contrario, los valores serán diferentes de lo que esperas (por ejemplo, `QueryInfo` o algo similar en lugar de `str`). Y tu editor no se quejará, y Python no se quejará al ejecutar esa función, solo cuando las operaciones internas generen errores.
|
||||
|
||||
Dado que `Annotated` puede tener más de una anotación de metadato, ahora podrías incluso usar la misma función con otras herramientas, como [Typer](https://typer.tiangolo.com/). 🚀
|
||||
|
||||
@@ -172,13 +172,13 @@ Puedes definir una <dfn title="Una expresión regular, regex o regexp es una sec
|
||||
|
||||
{* ../../docs_src/query_params_str_validations/tutorial004_an_py310.py hl[11] *}
|
||||
|
||||
Este patrón específico de expresión regular comprueba que el valor recibido del parámetro:
|
||||
Este patrón específico de expresión regular revisa que el valor recibido del parámetro:
|
||||
|
||||
* `^`: comienza con los siguientes caracteres, no tiene caracteres antes.
|
||||
* `fixedquery`: tiene el valor exacto `fixedquery`.
|
||||
* `$`: termina allí, no tiene más caracteres después de `fixedquery`.
|
||||
|
||||
Si te sientes perdido con todas estas ideas de "expresión regular", no te preocupes. Son un tema difícil para muchas personas. Aún puedes hacer muchas cosas sin necesitar expresiones regulares todavía.
|
||||
Si te sientes perdido con todas estas ideas de **"expresión regular"**, no te preocupes. Son un tema difícil para muchas personas. Aún puedes hacer muchas cosas sin necesitar expresiones regulares todavía.
|
||||
|
||||
Ahora sabes que cuando las necesites puedes usarlas en **FastAPI**.
|
||||
|
||||
@@ -296,9 +296,9 @@ También puedes usar `list` directamente en lugar de `list[str]`:
|
||||
|
||||
/// note | Nota
|
||||
|
||||
Ten en cuenta que en este caso, FastAPI no comprobará el contenido de la list.
|
||||
Ten en cuenta que en este caso, FastAPI no revisará el contenido de la list.
|
||||
|
||||
Por ejemplo, `list[int]` comprobaría (and documentaría) que el contenido de la list son enteros. Pero `list` sola no lo haría.
|
||||
Por ejemplo, `list[int]` revisaría (y documentaría) que el contenido de la list son enteros. Pero `list` sola no lo haría.
|
||||
|
||||
///
|
||||
|
||||
@@ -366,9 +366,9 @@ Para excluir un parámetro de query del esquema de OpenAPI generado (y por lo ta
|
||||
|
||||
## Validación personalizada { #custom-validation }
|
||||
|
||||
Podría haber casos donde necesites hacer alguna validación personalizada que no puede hacerse con los parámetros mostrados arriba.
|
||||
Podría haber casos donde necesites hacer alguna **validación personalizada** que no puede hacerse con los parámetros mostrados arriba.
|
||||
|
||||
En esos casos, puedes usar una función validadora personalizada que se aplique después de la validación normal (por ejemplo, después de validar que el valor es un `str`).
|
||||
En esos casos, puedes usar una **función validadora personalizada** que se aplique después de la validación normal (por ejemplo, después de validar que el valor es un `str`).
|
||||
|
||||
Puedes lograr eso usando [`AfterValidator` de Pydantic](https://docs.pydantic.dev/latest/concepts/validators/#field-after-validator) dentro de `Annotated`.
|
||||
|
||||
@@ -378,7 +378,7 @@ Pydantic también tiene [`BeforeValidator`](https://docs.pydantic.dev/latest/con
|
||||
|
||||
///
|
||||
|
||||
Por ejemplo, este validador personalizado comprueba que el ID del ítem empiece con `isbn-` para un número de libro <abbr title="International Standard Book Number - Número Estándar Internacional de Libros">ISBN</abbr> o con `imdb-` para un ID de URL de película de <abbr title="Internet Movie Database - Base de datos de películas en Internet: un sitio web con información sobre películas">IMDB</abbr>:
|
||||
Por ejemplo, este validador personalizado revisa que el ID del ítem empiece con `isbn-` para un número de libro <abbr title="International Standard Book Number - Número Estándar Internacional de Libros">ISBN</abbr> o con `imdb-` para un ID de URL de película de <abbr title="Internet Movie Database - Base de datos de películas en Internet: un sitio web con información sobre películas">IMDB</abbr>:
|
||||
|
||||
{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *}
|
||||
|
||||
@@ -390,15 +390,15 @@ Esto está disponible con Pydantic versión 2 o superior. 😎
|
||||
|
||||
/// tip | Consejo
|
||||
|
||||
Si necesitas hacer cualquier tipo de validación que requiera comunicarte con algún componente externo, como una base de datos u otra API, deberías usar Dependencias de FastAPI, las aprenderás más adelante.
|
||||
Si necesitas hacer cualquier tipo de validación que requiera comunicarte con algún **componente externo**, como una base de datos u otra API, deberías usar **Dependencias de FastAPI**, las aprenderás más adelante.
|
||||
|
||||
Estos validadores personalizados son para cosas que pueden comprobarse solo con los mismos datos provistos en el request.
|
||||
Estos validadores personalizados son para cosas que pueden revisarse **solo** con los **mismos datos** provistos en el request.
|
||||
|
||||
///
|
||||
|
||||
### Entiende ese código { #understand-that-code }
|
||||
|
||||
El punto importante es solo usar `AfterValidator` con una función dentro de `Annotated`. Si quieres, sáltate esta parte. 🤸
|
||||
El punto importante es solo usar **`AfterValidator` con una función dentro de `Annotated`**. Si quieres, sáltate esta parte. 🤸
|
||||
|
||||
---
|
||||
|
||||
@@ -406,7 +406,7 @@ Pero si te da curiosidad este ejemplo de código específico y sigues entretenid
|
||||
|
||||
#### String con `value.startswith()` { #string-with-value-startswith }
|
||||
|
||||
¿Lo notaste? un string usando `value.startswith()` puede recibir una tupla, y comprobará cada valor en la tupla:
|
||||
¿Lo notaste? Un string usando `value.startswith()` puede recibir una tupla, y revisará cada valor en la tupla:
|
||||
|
||||
{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py ln[16:19] hl[17] *}
|
||||
|
||||
@@ -416,13 +416,13 @@ Con `data.items()` obtenemos un <dfn title="Algo que podemos iterar con un for l
|
||||
|
||||
Convertimos este objeto iterable en una `list` propiamente dicha con `list(data.items())`.
|
||||
|
||||
Luego con `random.choice()` podemos obtener un valor aleatorio de la lista, así que obtenemos una tupla con `(id, name)`. Será algo como `("imdb-tt0371724", "The Hitchhiker's Guide to the Galaxy")`.
|
||||
Luego con `random.choice()` podemos obtener un **valor aleatorio** de la list, así que obtenemos una tupla con `(id, name)`. Será algo como `("imdb-tt0371724", "The Hitchhiker's Guide to the Galaxy")`.
|
||||
|
||||
Luego asignamos esos dos valores de la tupla a las variables `id` y `name`.
|
||||
Luego **asignamos esos dos valores** de la tupla a las variables `id` y `name`.
|
||||
|
||||
Así, si el usuario no proporcionó un ID de ítem, aún recibirá una sugerencia aleatoria.
|
||||
|
||||
...hacemos todo esto en una sola línea simple. 🤯 ¿No te encanta Python? 🐍
|
||||
...hacemos todo esto en una **sola línea simple**. 🤯 ¿No te encanta Python? 🐍
|
||||
|
||||
{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py ln[22:30] hl[29] *}
|
||||
|
||||
|
||||
@@ -109,6 +109,7 @@ http://127.0.0.1:8000/items/foo?short=yes
|
||||
|
||||
o cualquier otra variación (mayúsculas, primera letra en mayúscula, etc.), tu función verá el parámetro `short` con un valor `bool` de `True`. De lo contrario, será `False`.
|
||||
|
||||
|
||||
## Múltiples parámetros de path y de query { #multiple-path-and-query-parameters }
|
||||
|
||||
Puedes declarar múltiples parámetros de path y de query al mismo tiempo, **FastAPI** sabe cuál es cuál.
|
||||
|
||||
@@ -16,13 +16,13 @@ Esto es porque los archivos subidos se envían como "form data".
|
||||
|
||||
///
|
||||
|
||||
## Importar `File` { #import-file }
|
||||
## Importa `File` { #import-file }
|
||||
|
||||
Importa `File` y `UploadFile` desde `fastapi`:
|
||||
|
||||
{* ../../docs_src/request_files/tutorial001_an_py310.py hl[3] *}
|
||||
|
||||
## Definir Parámetros `File` { #define-file-parameters }
|
||||
## Define Parámetros `File` { #define-file-parameters }
|
||||
|
||||
Crea parámetros de archivo de la misma manera que lo harías para `Body` o `Form`:
|
||||
|
||||
@@ -117,7 +117,7 @@ La manera en que los formularios de HTML (`<form></form>`) envían los datos al
|
||||
|
||||
/// note | Detalles Técnicos
|
||||
|
||||
Los datos de los forms normalmente se codifican usando el "media type" `application/x-www-form-urlencoded` cuando no incluyen archivos.
|
||||
Los datos de los formularios normalmente se codifican usando el "media type" `application/x-www-form-urlencoded` cuando no incluyen archivos.
|
||||
|
||||
Pero cuando el formulario incluye archivos, se codifica como `multipart/form-data`. Si usas `File`, **FastAPI** sabrá que tiene que obtener los archivos de la parte correcta del cuerpo.
|
||||
|
||||
|
||||
@@ -14,13 +14,13 @@ $ pip install python-multipart
|
||||
|
||||
///
|
||||
|
||||
## Importar `Form` { #import-form }
|
||||
## Importa `Form` { #import-form }
|
||||
|
||||
Importar `Form` desde `fastapi`:
|
||||
Importa `Form` desde `fastapi`:
|
||||
|
||||
{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[3] *}
|
||||
|
||||
## Definir parámetros de `Form` { #define-form-parameters }
|
||||
## Define parámetros de `Form` { #define-form-parameters }
|
||||
|
||||
Crea parámetros de formulario de la misma manera que lo harías para `Body` o `Query`:
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# Código de Estado del Response { #response-status-code }
|
||||
|
||||
|
||||
De la misma manera que puedes especificar un modelo de response, también puedes declarar el código de estado HTTP usado para el response con el parámetro `status_code` en cualquiera de las *path operations*:
|
||||
|
||||
* `@app.get()`
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Declarar Datos de Ejemplo de Request { #declare-request-example-data }
|
||||
# Declara Datos de Ejemplo de Request { #declare-request-example-data }
|
||||
|
||||
Puedes declarar ejemplos de los datos que tu aplicación puede recibir.
|
||||
|
||||
|
||||
@@ -146,7 +146,7 @@ Usar una URL relativa es importante para asegurarse de que tu aplicación siga f
|
||||
|
||||
Este parámetro no crea ese endpoint / *path operation*, pero declara que la URL `/token` será la que el cliente deberá usar para obtener el token. Esa información se usa en OpenAPI, y luego en los sistemas de documentación interactiva del API.
|
||||
|
||||
Pronto también crearemos la verdadera *path operation*.
|
||||
Pronto también crearemos la path operation real.
|
||||
|
||||
/// note | Nota
|
||||
|
||||
@@ -174,13 +174,13 @@ Ahora puedes pasar ese `oauth2_scheme` en una dependencia con `Depends`.
|
||||
|
||||
Esta dependencia proporcionará un `str` que se asigna al parámetro `token` de la *path operation function*.
|
||||
|
||||
**FastAPI** sabrá que puede usar esta dependencia para definir un "security scheme" en el esquema OpenAPI (y en los docs automáticos del API).
|
||||
**FastAPI** sabrá que puede usar esta dependencia para definir un "security scheme" en el esquema OpenAPI (y en la documentación automática de la API).
|
||||
|
||||
/// note | Detalles técnicos
|
||||
|
||||
**FastAPI** sabrá que puede usar la clase `OAuth2PasswordBearer` (declarada en una dependencia) para definir el esquema de seguridad en OpenAPI porque hereda de `fastapi.security.oauth2.OAuth2`, que a su vez hereda de `fastapi.security.base.SecurityBase`.
|
||||
|
||||
Todas las utilidades de seguridad que se integran con OpenAPI (y los docs automáticos del API) heredan de `SecurityBase`, así es como **FastAPI** puede saber cómo integrarlas en OpenAPI.
|
||||
Todas las utilidades de seguridad que se integran con OpenAPI (y la documentación automática de la API) heredan de `SecurityBase`, así es como **FastAPI** puede saber cómo integrarlas en OpenAPI.
|
||||
|
||||
///
|
||||
|
||||
|
||||
@@ -4,7 +4,9 @@ En el capítulo anterior, el sistema de seguridad (que se basa en el sistema de
|
||||
|
||||
{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *}
|
||||
|
||||
Pero eso aún no es tan útil. Vamos a hacer que nos dé el usuario actual.
|
||||
Pero eso aún no es tan útil.
|
||||
|
||||
Vamos a hacer que nos dé el usuario actual.
|
||||
|
||||
## Crear un modelo de usuario { #create-a-user-model }
|
||||
|
||||
@@ -12,7 +14,7 @@ Primero, vamos a crear un modelo de usuario con Pydantic.
|
||||
|
||||
De la misma manera que usamos Pydantic para declarar cuerpos, podemos usarlo en cualquier otra parte:
|
||||
|
||||
{* ../../docs_src/security/tutorial002_an_py310.py hl[5,12:6] *}
|
||||
{* ../../docs_src/security/tutorial002_an_py310.py hl[5,12:16] *}
|
||||
|
||||
## Crear una dependencia `get_current_user` { #create-a-get-current-user-dependency }
|
||||
|
||||
@@ -66,7 +68,7 @@ Y puedes usar cualquier modelo o datos para los requisitos de seguridad (en este
|
||||
|
||||
Pero no estás limitado a usar algún modelo de datos, clase o tipo específico.
|
||||
|
||||
¿Quieres tener un `id` y `email` y no tener un `username` en tu modelo? Claro. Puedes usar estas mismas herramientas.
|
||||
¿Quieres tener un `id` y `email` y no tener ningún `username` en tu modelo? Claro. Puedes usar estas mismas herramientas.
|
||||
|
||||
¿Quieres solo tener un `str`? ¿O solo un `dict`? ¿O un instance de clase modelo de base de datos directamente? Todo funciona de la misma manera.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# OAuth2 con Password (y hashing), Bearer con tokens JWT { #oauth2-with-password-and-hashing-bearer-with-jwt-tokens }
|
||||
|
||||
|
||||
Ahora que tenemos todo el flujo de seguridad, hagamos que la aplicación sea realmente segura, usando tokens <abbr title="JSON Web Tokens">JWT</abbr> y hashing de contraseñas seguras.
|
||||
|
||||
Este código es algo que puedes usar realmente en tu aplicación, guardar los hashes de las contraseñas en tu base de datos, etc.
|
||||
|
||||
@@ -146,7 +146,7 @@ UserInDB(
|
||||
|
||||
/// note | Nota
|
||||
|
||||
Para una explicación más completa de `**user_dict` revisa en [la documentación para **Extra Models**](../extra-models.md#about-user-in-dict).
|
||||
Para una explicación más completa de `**user_dict` revisa en [la documentación para **Extra Models**](../extra-models.md#about-user-in-model-dump).
|
||||
|
||||
///
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ Hay algunas diferencias:
|
||||
|
||||
* `Field(primary_key=True)` le dice a SQLModel que `id` es la **clave primaria** en la base de datos SQL (puedes aprender más sobre claves primarias de SQL en la documentación de SQLModel).
|
||||
|
||||
Nota: Usamos `int | None` para el campo de clave primaria para que en el código Python podamos *crear un objeto sin un `id`* (`id=None`), asumiendo que la base de datos lo *generará al guardar*. SQLModel entiende que la base de datos proporcionará el `id` y *define la columna como un `INTEGER` no nulo* en el esquema de la base de datos. Consulta la [documentación de SQLModel sobre claves primarias](https://sqlmodel.tiangolo.com/tutorial/create-db-and-table/#primary-key-id) para más detalles.
|
||||
**Nota:** Usamos `int | None` para el campo de clave primaria para que en el código Python podamos *crear un objeto sin un `id`* (`id=None`), asumiendo que la base de datos lo *generará al guardar*. SQLModel entiende que la base de datos proporcionará el `id` y *define la columna como un `INTEGER` no nulo* en el esquema de la base de datos. Consulta la [documentación de SQLModel sobre claves primarias](https://sqlmodel.tiangolo.com/tutorial/create-db-and-table/#primary-key-id) para más detalles.
|
||||
|
||||
* `Field(index=True)` le dice a SQLModel que debe crear un **índice SQL** para esta columna, lo que permitirá búsquedas más rápidas en la base de datos cuando se lean datos filtrados por esta columna.
|
||||
|
||||
@@ -181,7 +181,7 @@ Arreglaremos estas cosas añadiendo unos **modelos extra**. Aquí es donde SQLMo
|
||||
|
||||
En **SQLModel**, cualquier clase de modelo que tenga `table=True` es un **modelo de tabla**.
|
||||
|
||||
Y cualquier clase de modelo que no tenga `table=True` es un **modelo de datos**, estos son en realidad solo modelos de Pydantic (con un par de características extra pequeñas). 🤓
|
||||
Y cualquier clase de modelo que no tenga `table=True` es un **modelo de datos**, estos son en realidad solo modelos de Pydantic (con un par de pequeñas funcionalidades extra). 🤓
|
||||
|
||||
Con SQLModel, podemos usar **herencia** para **evitar duplicar** todos los campos en todos los casos.
|
||||
|
||||
@@ -296,7 +296,7 @@ Ahora usamos `response_model=HeroPublic` en lugar de la **anotación de tipo de
|
||||
|
||||
Si hubiéramos declarado `-> HeroPublic`, tu editor y linter se quejarían (con razón) de que estás devolviendo un `Hero` en lugar de un `HeroPublic`.
|
||||
|
||||
Al declararlo en `response_model` le estamos diciendo a **FastAPI** que haga lo suyo, sin interferir con las anotaciones de tipo y la ayuda de tu editor y otras herramientas.
|
||||
Al declararlo en `response_model` le estamos diciendo a **FastAPI** que haga lo suyo, sin interferir con las anotaciones de tipos y la ayuda de tu editor y otras herramientas.
|
||||
|
||||
///
|
||||
|
||||
|
||||
@@ -2,6 +2,14 @@
|
||||
|
||||
Puedes servir archivos estáticos automáticamente desde un directorio utilizando `StaticFiles`.
|
||||
|
||||
/// tip | Consejo
|
||||
|
||||
Si necesitas alojar un frontend, usa `app.frontend()` en su lugar, lee sobre ello en [Frontend](frontend.md).
|
||||
|
||||
`app.frontend()` usa `StaticFiles` por debajo, con varias ventajas adicionales para frontends, como manejar el routing del lado del cliente.
|
||||
|
||||
///
|
||||
|
||||
## Usa `StaticFiles` { #use-staticfiles }
|
||||
|
||||
* Importa `StaticFiles`.
|
||||
|
||||
@@ -28,7 +28,7 @@ Crea funciones con un nombre que comience con `test_` (esta es la convención es
|
||||
|
||||
Usa el objeto `TestClient` de la misma manera que con `httpx`.
|
||||
|
||||
Escribe declaraciones `assert` simples con las expresiones estándar de Python que necesites revisar (otra vez, estándar de `pytest`).
|
||||
Escribe statements `assert` simples con las expresiones estándar de Python que necesites revisar (otra vez, estándar de `pytest`).
|
||||
|
||||
{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *}
|
||||
|
||||
@@ -90,7 +90,7 @@ Entonces podrías tener un archivo `test_main.py` con tus pruebas. Podría estar
|
||||
│ └── test_main.py
|
||||
```
|
||||
|
||||
Debido a que este archivo está en el mismo paquete, puedes usar importaciones relativas para importar el objeto `app` desde el módulo `main` (`main.py`):
|
||||
Debido a que este archivo está en el mismo paquete, puedes usar imports relativos para importar el objeto `app` desde el módulo `main` (`main.py`):
|
||||
|
||||
{* ../../docs_src/app_testing/app_a_py310/test_main.py hl[3] *}
|
||||
|
||||
|
||||
Reference in new issue
Block a user