FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
The key features are:
FastAPI é um moderno e rápido (alta performance) _framework web_ para construção de APIs com Python 3.6 ou superior, baseado nos _type hints_ padrões do Python.
* **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).
Os recursos chave são:
* **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>.
* **Rápido**: alta performance, equivalente a **NodeJS** e **Go** (graças ao Starlette e Pydantic). [Um dos frameworks mais rápidos disponíveis](#performance).
* **Rápido para codar**: Aumenta a velocidade para desenvolver recursos entre 200% a 300%. *
* **Poucos bugs**: Reduz cerca de 40% de erros iduzidos por humanos (desenvolvedores). *
* **Intuitivo**: Grande suporte a _IDEs_. <abbrtitle="também conhecido como_auto-complete_,_autocompletion_,_IntelliSense_">_Auto-Complete_</abbr> em todos os lugares. Menos tempo debugando.
* **Fácil**: Projetado para ser fácil de aprender e usar. Menos tempo lendo documentação.
* **Enxuto**: Minimize duplicação de código. Múltiplos recursos para cada declaração de parâmetro. Menos bugs.
* **Robusto**: Tenha código pronto para produção. E com documentação interativa automática.
* **Baseado em padrões**: Baseado em (e totalmente compatível com) os padrões abertos para APIs: <ahref="https://github.com/OAI/OpenAPI-Specification"class="external-link"target="_blank">OpenAPI</a> (anteriormente conhecido como Swagger) e <ahref="http://json-schema.org/"class="external-link"target="_blank">_JSON Schema_</a>.
<small>* estimation based on tests on an internal development team, building production applications.</small>
<small>* estimativas baseadas em testes realizados com equipe interna de desenvolvimento, construindo aplicações em produção.</small>
## Opinions
## Opiniões
"*[...] 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.*"
"*[...] Estou usando **FastAPI** muito esses dias. [...] Estou na verdade planejando utilizar ele em todos os times de **serviços _Machine Learning_ na Microsoft**. Alguns deles estão sendo integrados no _core_ do produto **Windows** e alguns produtos **Office**.*"
"*Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that.*"
"*Honestamente, o que você construiu parece super sólido e rebuscado. De muitas formas, eu queria que o **Hug** fosse assim - é realmente inspirador ver alguém que construiu ele.*"
"*If you're looking to learn one **modern framework** for building REST APIs, check out **FastAPI** [...] It's fast, easy to use and easy to learn [...]*"
"*Se você está procurando aprender um **_framework_ moderno** para construir aplicações _REST_, dê uma olhada no **FastAPI** [...] É rápido, fácil de usar e fácil de aprender [...]*"
"*We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]*"
"*Nós trocamos nossas **APIs** por **FastAPI** [...] Acredito que vocês gostarão dele [...]*"
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>.
Se você estiver construindo uma aplicação<abbrtitle="Command Line Interface">_CLI_</abbr>para ser utilizada em um terminal ao invés de uma aplicação web, dê uma olhada no<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** é o irmão menor do FastAPI. E seu propósito é ser o **FastAPI das _CLIs_**. ⌨️ 🚀
## Requirements
## Requisitos
Python 3.6+
FastAPI stands on the shoulders of giants:
FastAPI está nos ombros 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 as partes web.
* <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>para a parte de dados.
## Installation
## Instalação
<divclass="termy">
@ -110,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>.
Você também precisará de um servidor ASGI para produção, tal como<ahref="http://www.uvicorn.org"class="external-link"target="_blank">Uvicorn</a> ou<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>.
Se você não sabe, verifique a seção _"In a hurry?"_ sobre<ahref="https://fastapi.tiangolo.com/async/#in-a-hurry"target="_blank">`async` e `await` nas docs</a>.
</details>
### Run it
### Rode
Run the server with:
Rode o servidor com:
<divclass="termy">
```console
$ uvicorn main:app --reload
<spanstyle="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
<spanstyle="color: green;">INFO</span>: Started reloader process [28720]
<spanstyle="color: green;">INFO</span>: Started server process [28722]
<spanstyle="color: green;">INFO</span>: Waiting for application startup.
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [28720]
INFO: Started server process [28722]
INFO: Waiting for application startup.
INFO: Application startup complete.
```
</div>
<detailsmarkdown="1">
<summary>About the command<code>uvicorn main:app --reload</code>...</summary>
<summary>Sobre o comando<code>uvicorn main:app --reload</code>...</summary>
The command `uvicorn main:app` refers to:
O comando `uvicorn main:app` se refere 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`: o arquivo `main.py` (o "módulo" Python).
* `app`: o objeto criado dentro de `main.py` com a linha`app = FastAPI()`.
* `--reload`: faz o servidor recarregar após mudanças de código. Somente faça isso para desenvolvimento.
</details>
### Check it
### Verifique
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>.
Abra seu navegador em<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:
Você verá a resposta JSON como:
```JSON
{"item_id": 5, "q": "somequery"}
```
You already created an API that:
Você acabou de criar uma 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`.
* Recebe requisições HTTP nas _rotas_`/` e`/items/{item_id}`.
* Ambas _rotas_ fazem <em>operações</em>`GET` (também conhecido como _métodos_ HTTP).
* A _rota_`/items/{item_id}` tem um _parâmetro de rota_`item_id` que deve ser um`int`.
* A _rota_`/items/{item_id}` tem um _parâmetro query_`q``str` opcional.
### Interactive API docs
### Documentação Interativa da API
Now go to<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>):
Você verá a documentação automática interativa da API (fornecida 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>.
E agora, vá para<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>):
Você verá a documentação automática alternativa (fornecida 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:
* Então clique no botão "Execute", a interface do usuário irá se comunicar com a API, enviar os parâmetros, pegar os resultados e mostrá-los na tela:
In summary, you declare **once** the types of parameters, body, etc. as function parameters.
Resumindo, você declara **uma vez** os tipos dos parâmetros, corpo etc. como parâmetros de função.
You do that with standard modern Python types.
Você faz com tipos padrão do Python moderno.
You don't have to learn a new syntax, the methods or classes of a specific library, etc.
Você não terá que aprender uma nova sintaxe, métodos ou classes de uma biblioteca específica etc.
Just standard **Python 3.6+**.
Apenas **Python 3.6+** padrão.
For example, for an`int`:
Por exemplo, para um`int`:
```Python
item_id: int
```
or for a more complex `Item` model:
ou para um modelo mais complexo, `Item`:
```Python
item: Item
```
...and with that single declaration you get:
...e com essa única declaração você tem:
* 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:
* Suporte ao Editor, incluindo:
* Completação.
* Verificação de tipos.
* Validação de dados:
* Erros automáticos e claros quando o dado é inválido.
* Validação até para objetos JSON profundamente aninhados.
* <abbrtitle="também conhecido como: serialization, parsing, marshalling">Conversão</abbr>de dados de entrada: vindo da rede para dados e tipos Python. Consegue ler:
* 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:
* Parâmetros de rota.
* Parâmetros de _query_.
* _Cookies_.
* Cabeçalhos.
* Formulários.
* Arquivos.
* <abbrtitle="também conhecido como: serialization, parsing, marshalling">Conversão</abbr>de dados de saída de tipos e dados Python para dados de rede (como JSON):
* Documentação interativa automática da API, incluindo 2 alternativas de interface de usuário:
* Swagger UI.
* ReDoc.
---
Coming back to the previous code example, **FastAPI** will:
* Validate that there is an `item_id` in the path for `GET` and `PUT` requests.
* Validate that the `item_id` is of type `int` for `GET` and `PUT` requests.
* If it is not, the client will see a useful, clear error.
* Check if there is an optional query parameter named `q` (as in `http://127.0.0.1:8000/items/foo?q=somequery`) for `GET` requests.
* As the `q` parameter is declared with `= None`, it is optional.
* Without the `None` it would be required (as is the body in the case with`PUT`).
* For `PUT` requests to `/items/{item_id}`, Read the body as JSON:
* Check that it has a required attribute `name` that should be a`str`.
* Check that it has a required attribute `price` that has to be a`float`.
* Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.
* All this would also work for deeply nested JSON objects.
* Convert from and to JSON automatically.
* Document everything with OpenAPI, that can be used by:
* Interactive documentation systems.
* Automatic client code generation systems, for many languages.
* Provide 2 interactive documentation web interfaces directly.
Voltando ao código do exemplo anterior, **FastAPI** irá:
* Validar que existe um `item_id` na rota para requisições `GET` e `PUT`.
* Validar que `item_id` é do tipo `int` para requisições `GET` e `PUT`.
* Se não é validado, o cliente verá um útil, claro erro.
* Verificar se existe um parâmetro de _query_ opcional nomeado como `q` (como em `http://127.0.0.1:8000/items/foo?q=somequery`) para requisições `GET`.
* Como o parâmetro `q` é declarado com `= None`, ele é opcional.
* Sem o `None` ele poderia ser obrigatório (como o corpo no caso de`PUT`).
* Para requisições `PUT` para `/items/{item_id}`, lerá o corpo como JSON e:
* Verifica que tem um atributo obrigatório `name` que deve ser`str`.
* Verifica que tem um atributo obrigatório `price` que deve ser`float`.
* Verifica que tem an atributo opcional `is_offer`, que deve ser `bool`, se presente.
* Tudo isso também funciona para objetos JSON profundamente aninhados.
* Converter de e para JSON automaticamente.
* Documentar tudo com OpenAPI, que poderá ser usado por:
* Sistemas de documentação interativos.
* Sistemas de clientes de geração de código automáticos, para muitas linguagens.
* Fornecer diretamente 2 interfaces _web_ de documentação interativa.
---
We just scratched the surface, but you already get the idea of how it all works.
Nós arranhamos apenas a superfície, mas você já tem idéia de como tudo funciona.
For a more complete example including more features, see the<ahref="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>.
Para um exemplo mais completo incluindo mais recursos, veja<ahref="https://fastapi.tiangolo.com/tutorial/">Tutorial - Guia do Usuário</a>.
**Spoiler alert**: the tutorial - user guide includes:
**Alerta de Spoiler**: o tutorial - guia do usuário inclui:
* 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:
* Declaração de **parâmetetros** de diferentes lugares como: **cabeçalhos**, **cookies**, **campos de formulários** e **arquivos**.
* Como configurar **Limitações de Validação** como `maximum_length` ou`regex`.
* Um poderoso e fácil de usar sistema de **<abbrtitle="também conhecido como componentes, recursos, fornecedores, serviços, injetáveis">Injeção de Dependência</abbr>**.
* Segurança e autenticação, incluindo suporte para **OAuth2** com autenticação **JWT tokens** e **HTTP Basic**.
* Técnicas mais avançadas (mas igualmente fáceis) para declaração de **modelos JSON profundamente aninhados** (graças ao Pydantic).
* Muitos recursos extras (graças ao Starlette) como:
* **WebSockets**
* **GraphQL**
* extremely easy tests based on `requests` and`pytest`
* testes extrememamente fáceis baseados em `requests` e`pytest`
* **CORS**
* **Cookie Sessions**
* ...and more.
* ...e mais.
## Performance
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). (*)
Testes de performance da _Independent TechEmpower_ mostram aplicações **FastAPI** rodando sob Uvicorn como<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">um dos _frameworks_ Python mais rápidos disponíveis</a>, somente atrás de Starlette e Uvicorn (utilizados internamente pelo FastAPI). (*)
To understand more about it, see the section<ahref="https://fastapi.tiangolo.com/benchmarks/"class="internal-link"target="_blank">Benchmarks</a>.
Para entender mais sobre performance, veja a seção<ahref="https://fastapi.tiangolo.com/benchmarks/"class="internal-link"target="_blank">Benchmarks</a>.
## Optional Dependencies
## Dependências opcionais
Used by Pydantic:
Usados 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 JSON mais rápido<abbrtitle="converte uma string que chega de uma requisição HTTP para dados Python">"parsing"</abbr>.
* <ahref="https://github.com/JoshData/python-email-validator"target="_blank"><code>email_validator</code></a> - para validação de email.
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> - Necessário se você quiser utilizar o`TestClient`.
* <ahref="https://github.com/Tinche/aiofiles"target="_blank"><code>aiofiles</code></a> - Necessário se você quiser utilizar o `FileResponse` ou`StaticFiles`.
* <ahref="http://jinja.pocoo.org"target="_blank"><code>jinja2</code></a> - Necessário se você quiser utilizar a configuração padrão de templates.
* <ahref="https://andrew-d.github.io/python-multipart/"target="_blank"><code>python-multipart</code></a> - Necessário se você quiser suporte com <abbrtitle="converte uma string que chega de uma requisição HTTP para dados Python">"parsing"</abbr> de formulário, com`request.form()`.
* <ahref="https://pythonhosted.org/itsdangerous/"target="_blank"><code>itsdangerous</code></a> - Necessário para suporte a `SessionMiddleware`.
* <ahref="https://pyyaml.org/wiki/PyYAMLDocumentation"target="_blank"><code>pyyaml</code></a> - Necessário para suporte a `SchemaGenerator` da Starlette (você provavelmente não precisará disso com o FastAPI).
* <ahref="https://graphene-python.org/"target="_blank"><code>graphene</code></a> - Necessário para suporte a `GraphQLApp`.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - Necessário se você quer utilizar`UJSONResponse`.
Used by FastAPI / Starlette:
Usados 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 o servidor que carrega e serve sua aplicação.
* <ahref="https://github.com/ijl/orjson"target="_blank"><code>orjson</code></a> - Necessário se você quer utilizar`ORJSONResponse`.
You can install all of these with`pip install fastapi[all]`.
Você pode instalar todas essas dependências com`pip install fastapi[all]`.
## License
## Licença
This project is licensed under the terms of the MIT license.
Esse projeto é licenciado sob os termos da licença MIT.
Fabio Serrao
5 years ago
GitHub