FastAPI es un web framework moderno y rápido (de alto rendimiento) para construir APIs con Python 3.6+ basado en las anotaciones de tipos estándar de Python.
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
Sus características principales son:
The key features are:
* **Rapidez**: Alto rendimiento, a la par con **NodeJS** y **Go** (gracias a Starlette y Pydantic). [Uno de los frameworks de Python más rápidos](#rendimiento).
* **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).
* **Rápido de programar**: Incrementa la velocidad de desarrollo entre 200% y 300% *.
* **Menos errores**: Reduce los errores humanos (de programador) aproximadamente un 40% *.
* **Intuitivo**: Gran soporte en los editores con <abbrtitle="conocido en inglés como auto-complete, autocompletion, IntelliSense, completion">auto completado</abbr> en todas partes. Gasta menos tiempo <abbrtitle="buscando y corrigiendo errores">debugging</abbr>.
* **Fácil**: Está diseñado para ser fácil de usar y aprender. Gastando menos tiempo leyendo documentación.
* **Corto**: Minimiza la duplicación de código. Múltiples funcionalidades con cada declaración de parámetros. Menos errores.
* **Robusto**: Crea código listo para producción con documentación automática interactiva.
* **Basado en estándares**: Basado y totalmente compatible con los estándares abiertos para APIs: <ahref="https://github.com/OAI/OpenAPI-Specification"class="external-link"target="_blank">OpenAPI</a> (conocido previamente como Swagger) y <ahref="http://json-schema.org/"class="external-link"target="_blank">JSON Schema</a>.
* **Fast to code**: Increase the speed to develop features by about 200% to 300% *.
* **Fewer bugs**: Reduce about 40% of human (developer) induced errors. *
* **Intuitive**: Great editor support. <abbrtitle="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging.
* **Easy**: Designed to be easy to use and learn. Less time reading docs.
* **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
* **Robust**: Get production-ready code. With automatic interactive documentation.
* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <ahref="https://github.com/OAI/OpenAPI-Specification"class="external-link"target="_blank">OpenAPI</a> (previously known as Swagger) and <ahref="http://json-schema.org/"class="external-link"target="_blank">JSON Schema</a>.
<small>* Esta estimación está basada en pruebas con un equipo de desarrollo interno contruyendo aplicaciones listas para producción.</small>
<small>* estimation based on tests on an internal development team, building production applications.</small>
## Opinions
## Opiniones
"*[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products.*"
If you are building a<abbrtitle="Command Line Interface">CLI</abbr>app to be used in the terminal instead of a web API, check out<ahref="https://typer.tiangolo.com/"class="external-link"target="_blank">**Typer**</a>.
Si estás construyendo un app de<abbrtitle="Interfaz de línea de comandos en español">CLI</abbr>para ser usada en la terminal en vez de una API web, fíjate en<ahref="https://typer.tiangolo.com/"class="external-link"target="_blank">**Typer**</a>.
**Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
**Typer** es el hermano menor de FastAPI. La intención es que sea el **FastAPI de las CLIs**. ⌨️ 🚀
## Requirements
## Requisitos
Python 3.6+
FastAPI stands on the shoulders of giants:
FastAPI está sobre los hombros de gigantes:
* <ahref="https://www.starlette.io/"class="external-link"target="_blank">Starlette</a>for the web parts.
* <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>for the data parts.
* <ahref="https://www.starlette.io/"class="external-link"target="_blank">Starlette</a>para las partes web.
* <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>para las partes de datos.
## Installation
## Instalación
<divclass="termy">
@ -106,7 +105,7 @@ $ pip install fastapi
</div>
You will also need an ASGI server, for production such as<ahref="http://www.uvicorn.org"class="external-link"target="_blank">Uvicorn</a> or<ahref="https://gitlab.com/pgjones/hypercorn"class="external-link"target="_blank">Hypercorn</a>.
También vas a necesitar un servidor ASGI para producción cómo<ahref="http://www.uvicorn.org"class="external-link"target="_blank">Uvicorn</a> o <ahref="https://gitlab.com/pgjones/hypercorn"class="external-link"target="_blank">Hypercorn</a>.
If you don't know, check the _"In a hurry?"_ section about<ahref="https://fastapi.tiangolo.com/async/#in-a-hurry"target="_blank">`async` and `await` in the docs</a>.
Si no lo sabes, revisa la sección _"¿Con prisa?"_ sobre<ahref="https://fastapi.tiangolo.com/es/async/#con-prisa"target="_blank">`async` y `await` en la documentación</a>.
</details>
### Run it
### Córrelo
Run the server with:
Corre el servidor con:
<divclass="termy">
@ -186,54 +185,54 @@ $ uvicorn main:app --reload
</div>
<detailsmarkdown="1">
<summary>About the command<code>uvicorn main:app --reload</code>...</summary>
<summary>Sobre el comando<code>uvicorn main:app --reload</code>...</summary>
The command `uvicorn main:app` refers to:
El comando `uvicorn main:app` se refiere a:
* `main`: the file `main.py` (the Python "module").
* `app`: the object created inside of `main.py` with the line`app = FastAPI()`.
* `--reload`: make the server restart after code changes. Only do this for development.
* `main`: el archivo `main.py` (el"modulo" de Python).
* `app`: el objeto creado dentro de `main.py` con la línea`app = FastAPI()`.
* `--reload`: hace que el servidor se reinicie después de cambios en el código. Esta opción solo debe ser usada en desarrollo.
</details>
### Check it
### Revísalo
Open your browser at<ahref="http://127.0.0.1:8000/items/5?q=somequery"class="external-link"target="_blank">http://127.0.0.1:8000/items/5?q=somequery</a>.
Abre tu navegador en<ahref="http://127.0.0.1:8000/items/5?q=somequery"class="external-link"target="_blank">http://127.0.0.1:8000/items/5?q=somequery</a>.
You will see the JSON response as:
Verás la respuesta de JSON cómo:
```JSON
{"item_id": 5, "q": "somequery"}
```
You already created an API that:
Ya creaste una API que:
* Receives HTTP requests in the _paths_`/` and`/items/{item_id}`.
* Both _paths_ take `GET`<em>operations</em> (also known as HTTP _methods_).
* The _path_`/items/{item_id}` has a _path parameter_`item_id` that should be an `int`.
* The _path_`/items/{item_id}` has an optional`str`_query parameter_`q`.
* Recibe HTTP requests en los _paths_`/` y`/items/{item_id}`.
* Ambos _paths_ toman <em>operaciones</em>`GET` (también conocido como HTTP _methods_).
* El _path_`/items/{item_id}` tiene un _path parameter_`item_id` que debería ser un `int`.
* El _path_`/items/{item_id}` tiene un`str`_query parameter_`q` opcional.
### Interactive API docs
### Documentación interactiva de APIs
Now go to<ahref="http://127.0.0.1:8000/docs"class="external-link"target="_blank">http://127.0.0.1:8000/docs</a>.
Ahora ve a<ahref="http://127.0.0.1:8000/docs"class="external-link"target="_blank">http://127.0.0.1:8000/docs</a>.
You will see the automatic interactive API documentation (provided by<ahref="https://github.com/swagger-api/swagger-ui"class="external-link"target="_blank">Swagger UI</a>):
Verás la documentación automática e interactiva de la API (proveída por<ahref="https://github.com/swagger-api/swagger-ui"class="external-link"target="_blank">Swagger UI</a>):
And now, go to<ahref="http://127.0.0.1:8000/redoc"class="external-link"target="_blank">http://127.0.0.1:8000/redoc</a>.
Ahora, ve a<ahref="http://127.0.0.1:8000/redoc"class="external-link"target="_blank">http://127.0.0.1:8000/redoc</a>.
You will see the alternative automatic documentation (provided by<ahref="https://github.com/Rebilly/ReDoc"class="external-link"target="_blank">ReDoc</a>):
Ahora verás la documentación automática alternativa (proveída por<ahref="https://github.com/Rebilly/ReDoc"class="external-link"target="_blank">ReDoc</a>):
* Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
* Luego haz clíck en el botón de "Execute". La interfaz de usuario se comunicará con tu API, enviará los parámetros y recibirá los resultados para mostrarlos en pantalla:
In summary, you declare **once** the types of parameters, body, etc. as function parameters.
En resumen, declaras los tipos de parámetros, body, etc. **una vez** como parámetros de la función.
You do that with standard modern Python types.
Lo haces con tipos modernos estándar de Python.
You don't have to learn a new syntax, the methods or classes of a specific library, etc.
No tienes que aprender una sintáxis nueva, los métodos o clases de una library específica, etc.
Just standard **Python 3.6+**.
Solo **Python 3.6+** estándar.
For example, for an `int`:
Por ejemplo, para un `int`:
```Python
item_id: int
```
or for a more complex `Item` model:
o para un modelo más complejo de `Item`:
```Python
item: Item
```
...and with that single declaration you get:
...y con esa única declaración obtienes:
* Editor support, including:
* Completion.
* Type checks.
* Validation of data:
* Automatic and clear errors when the data is invalid.
* Validation even for deeply nested JSON objects.
* <abbrtitle="also known as: serialization, parsing, marshalling">Conversion</abbr>of input data: coming from the network to Python data and types. Reading from:
* Soporte del editor incluyendo:
* Auto completado.
* Anotaciones de tipos.
* Validación de datos:
* Errores automáticos y claros cuándo los datos son inválidos.
* Validación, incluso para objetos JSON profundamente anidados.
* <abbrtitle="en inglés: serialization, parsing, marshalling">Conversión</abbr>de datos de input: viniendo de la red a datos y tipos de Python. Leyendo desde:
* JSON.
* Path parameters.
* Query parameters.
* Cookies.
* Headers.
* Forms.
* Files.
* <abbrtitle="also known as: serialization, parsing, marshalling">Conversion</abbr>of output data: converting from Python data and types to network data (as JSON):
* Automatic interactive API documentation, including 2 alternative user interfaces:
* Formularios.
* Archivos.
* <abbrtitle="en inglés: serialization, parsing, marshalling">Conversión</abbr>de datos de output: convirtiendo de datos y tipos de Python a datos para la red (como JSON):
For a more complete example including more features, see the<ahref="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>.
Para un ejemplo más completo que incluye más características ve el<ahref="https://fastapi.tiangolo.com/tutorial/">Tutorial - Guía de Usuario</a>.
**Spoiler alert**: the tutorial - user guide includes:
**Spoiler alert**: el Tutorial - Guía de Usuario incluye:
* Declaration of **parameters** from other different places as: **headers**, **cookies**, **form fields** and **files**.
* How to set **validation constraints** as `maximum_length` or`regex`.
* A very powerful and easy to use **<abbrtitle="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** system.
* Security and authentication, including support for **OAuth2** with **JWT tokens** and**HTTP Basic** auth.
* More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
* Many extra features (thanks to Starlette) as:
* Declaración de **parámetros** en otros lugares diferentes cómo los: **headers**, **cookies**, **formularios** y **archivos**.
* Cómo agregar **requisitos de validación** cómo `maximum_length` o`regex`.
* Un sistema de **<abbrtitle="también conocido en inglés cómo: components, resources, providers, services, injectables">Dependency Injection</abbr>** poderoso y fácil de usar.
* Seguridad y autenticación incluyendo soporte para **OAuth2** con **JWT tokens** y**HTTP Basic** auth.
* Técnicas más avanzadas, pero igual de fáciles, para declarar **modelos de JSON profundamente anidados** (gracias a Pydantic).
* Muchas características extra (gracias a Starlette) como:
* **WebSockets**
* **GraphQL**
* extremely easy tests based on `requests` and`pytest`
* pruebas extremadamente fáciles con `requests` y`pytest`
* **CORS**
* **Cookie Sessions**
* ...and more.
* ...y mucho más.
## Performance
## Rendimiento
Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as<ahref="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7"class="external-link"target="_blank">one of the fastest Python frameworks available</a>, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
Benchmarks independientes de TechEmpower muestran que aplicaciones de **FastAPI** corriendo con Uvicorn cómo<ahref="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7"class="external-link"target="_blank">uno de los frameworks de Python más rápidos</a>, únicamente debajo de Starlette y Uvicorn (usados internamente por FastAPI). (*)
To understand more about it, see the section <ahref="https://fastapi.tiangolo.com/benchmarks/"class="internal-link"target="_blank">Benchmarks</a>.
Para entender más al respecto revisa la sección <ahref="https://fastapi.tiangolo.com/benchmarks/"class="internal-link"target="_blank">Benchmarks</a>.
## Optional Dependencies
## Dependencias Opcionales
Used by Pydantic:
Usadas por Pydantic:
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - for faster JSON<abbrtitle="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>.
* <ahref="https://github.com/JoshData/python-email-validator"target="_blank"><code>email_validator</code></a> - for email validation.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - para<abbrtitle="convertir el string que viene de un HTTP request a datos de Python">"parsing"</abbr> de JSON más rápido.
* <ahref="https://github.com/JoshData/python-email-validator"target="_blank"><code>email_validator</code></a> - para validación de emails.
Used by Starlette:
Usados por Starlette:
* <ahref="http://docs.python-requests.org"target="_blank"><code>requests</code></a> - Required if you want to use the`TestClient`.
* <ahref="https://github.com/Tinche/aiofiles"target="_blank"><code>aiofiles</code></a> - Required if you want to use `FileResponse` or`StaticFiles`.
* <ahref="http://jinja.pocoo.org"target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
* <ahref="https://andrew-d.github.io/python-multipart/"target="_blank"><code>python-multipart</code></a> - Required if you want to support form<abbrtitle="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with`request.form()`.
* <ahref="https://pythonhosted.org/itsdangerous/"target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support.
* <ahref="https://pyyaml.org/wiki/PyYAMLDocumentation"target="_blank"><code>pyyaml</code></a> - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
* <ahref="https://graphene-python.org/"target="_blank"><code>graphene</code></a> - Required for `GraphQLApp` support.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - Required if you want to use`UJSONResponse`.
* <ahref="http://docs.python-requests.org"target="_blank"><code>requests</code></a> - Requerido si quieres usar el`TestClient`.
* <ahref="https://github.com/Tinche/aiofiles"target="_blank"><code>aiofiles</code></a> - Requerido si quieres usar `FileResponse` o`StaticFiles`.
* <ahref="http://jinja.pocoo.org"target="_blank"><code>jinja2</code></a> - Requerido si quieres usar la configuración por defecto de templates.
* <ahref="https://andrew-d.github.io/python-multipart/"target="_blank"><code>python-multipart</code></a> - Requerido si quieres dar soporte a <abbrtitle="convertir el string que viene de un HTTP request a datos de Python">"parsing"</abbr> de formularios, con`request.form()`.
* <ahref="https://pythonhosted.org/itsdangerous/"target="_blank"><code>itsdangerous</code></a> - Requerido para dar soporte a `SessionMiddleware`.
* <ahref="https://pyyaml.org/wiki/PyYAMLDocumentation"target="_blank"><code>pyyaml</code></a> - Requerido para dar soporte al `SchemaGenerator` de Starlette (probablemente no lo necesites con FastAPI).
* <ahref="https://graphene-python.org/"target="_blank"><code>graphene</code></a> - Requerido para dar soporte a `GraphQLApp`.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - Requerido si quieres usar`UJSONResponse`.
Used by FastAPI / Starlette:
Usado por FastAPI / Starlette:
* <ahref="http://www.uvicorn.org"target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
* <ahref="https://github.com/ijl/orjson"target="_blank"><code>orjson</code></a> - Required if you want to use`ORJSONResponse`.
* <ahref="http://www.uvicorn.org"target="_blank"><code>uvicorn</code></a> - para el servidor que carga y sirve tu aplicación.
* <ahref="https://github.com/ijl/orjson"target="_blank"><code>orjson</code></a> - Requerido si quieres usar`ORJSONResponse`.
You can install all of these with`pip install fastapi[all]`.
Puedes instalarlos con`pip install fastapi[all]`.
## License
## Licencia
This project is licensed under the terms of the MIT license.
Este proyecto está licenciado bajo los términos de la licencia del MIT.
Camila Gutierrez
5 years ago
GitHub