Sebastián Ramírez
3 years ago
committed by
GitHub
GitHub
689 changed files with 18665 additions and 2918 deletions
@ -1,5 +0,0 @@ |
|||||
[flake8] |
|
||||
max-line-length = 88 |
|
||||
select = C,E,F,W,B,B9 |
|
||||
ignore = E203, E501, W503 |
|
||||
exclude = __init__.py |
|
||||
@ -0,0 +1,16 @@ |
|||||
|
version: 2 |
||||
|
updates: |
||||
|
# GitHub Actions |
||||
|
- package-ecosystem: "github-actions" |
||||
|
directory: "/" |
||||
|
schedule: |
||||
|
interval: "daily" |
||||
|
commit-message: |
||||
|
prefix: ⬆ |
||||
|
# Python |
||||
|
- package-ecosystem: "pip" |
||||
|
directory: "/" |
||||
|
schedule: |
||||
|
interval: "daily" |
||||
|
commit-message: |
||||
|
prefix: ⬆ |
||||
@ -10,22 +10,27 @@ jobs: |
|||||
preview-docs: |
preview-docs: |
||||
runs-on: ubuntu-latest |
runs-on: ubuntu-latest |
||||
steps: |
steps: |
||||
- uses: actions/checkout@v2 |
- uses: actions/checkout@v3 |
||||
|
- name: Clean site |
||||
|
run: | |
||||
|
rm -rf ./site |
||||
|
mkdir ./site |
||||
- name: Download Artifact Docs |
- name: Download Artifact Docs |
||||
uses: dawidd6/[email protected] |
uses: dawidd6/action-download-artifact@v2.24.2 |
||||
with: |
with: |
||||
github_token: ${{ secrets.GITHUB_TOKEN }} |
github_token: ${{ secrets.GITHUB_TOKEN }} |
||||
workflow: build-docs.yml |
workflow: build-docs.yml |
||||
run_id: ${{ github.event.workflow_run.id }} |
run_id: ${{ github.event.workflow_run.id }} |
||||
name: docs-zip |
name: docs-zip |
||||
|
path: ./site/ |
||||
- name: Unzip docs |
- name: Unzip docs |
||||
run: | |
run: | |
||||
rm -rf ./site |
cd ./site |
||||
unzip docs.zip |
unzip docs.zip |
||||
rm -f docs.zip |
rm -f docs.zip |
||||
- name: Deploy to Netlify |
- name: Deploy to Netlify |
||||
id: netlify |
id: netlify |
||||
uses: nwtgck/actions-netlify@v1.1.5 |
uses: nwtgck/actions-netlify@v2.0.0 |
||||
with: |
with: |
||||
publish-dir: './site' |
publish-dir: './site' |
||||
production-deploy: false |
production-deploy: false |
||||
|
|||||
@ -13,27 +13,27 @@ jobs: |
|||||
env: |
env: |
||||
GITHUB_CONTEXT: ${{ toJson(github) }} |
GITHUB_CONTEXT: ${{ toJson(github) }} |
||||
run: echo "$GITHUB_CONTEXT" |
run: echo "$GITHUB_CONTEXT" |
||||
- uses: actions/checkout@v2 |
- uses: actions/checkout@v3 |
||||
- name: Set up Python |
- name: Set up Python |
||||
uses: actions/setup-python@v2 |
uses: actions/setup-python@v4 |
||||
with: |
with: |
||||
python-version: "3.6" |
python-version: "3.7" |
||||
- uses: actions/cache@v2 |
cache: "pip" |
||||
|
cache-dependency-path: pyproject.toml |
||||
|
- uses: actions/cache@v3 |
||||
id: cache |
id: cache |
||||
with: |
with: |
||||
path: ${{ env.pythonLocation }} |
path: ${{ env.pythonLocation }} |
||||
key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-publish |
key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-publish |
||||
- name: Install Flit |
- name: Install build dependencies |
||||
if: steps.cache.outputs.cache-hit != 'true' |
if: steps.cache.outputs.cache-hit != 'true' |
||||
run: pip install flit |
run: pip install build |
||||
- name: Install Dependencies |
- name: Build distribution |
||||
if: steps.cache.outputs.cache-hit != 'true' |
run: python -m build |
||||
run: flit install --symlink |
|
||||
- name: Publish |
- name: Publish |
||||
env: |
uses: pypa/[email protected] |
||||
FLIT_USERNAME: ${{ secrets.FLIT_USERNAME }} |
with: |
||||
FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }} |
password: ${{ secrets.PYPI_API_TOKEN }} |
||||
run: bash scripts/publish.sh |
|
||||
- name: Dump GitHub context |
- name: Dump GitHub context |
||||
env: |
env: |
||||
GITHUB_CONTEXT: ${{ toJson(github) }} |
GITHUB_CONTEXT: ${{ toJson(github) }} |
||||
|
|||||
@ -0,0 +1,35 @@ |
|||||
|
name: Smokeshow |
||||
|
|
||||
|
on: |
||||
|
workflow_run: |
||||
|
workflows: [Test] |
||||
|
types: [completed] |
||||
|
|
||||
|
permissions: |
||||
|
statuses: write |
||||
|
|
||||
|
jobs: |
||||
|
smokeshow: |
||||
|
if: ${{ github.event.workflow_run.conclusion == 'success' }} |
||||
|
runs-on: ubuntu-latest |
||||
|
|
||||
|
steps: |
||||
|
- uses: actions/setup-python@v4 |
||||
|
with: |
||||
|
python-version: '3.9' |
||||
|
|
||||
|
- run: pip install smokeshow |
||||
|
|
||||
|
- uses: dawidd6/[email protected] |
||||
|
with: |
||||
|
workflow: test.yml |
||||
|
commit: ${{ github.event.workflow_run.head_sha }} |
||||
|
|
||||
|
- run: smokeshow upload coverage-html |
||||
|
env: |
||||
|
SMOKESHOW_GITHUB_STATUS_DESCRIPTION: Coverage {coverage-percentage} |
||||
|
SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 100 |
||||
|
SMOKESHOW_GITHUB_CONTEXT: coverage |
||||
|
SMOKESHOW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||
|
SMOKESHOW_GITHUB_PR_HEAD_SHA: ${{ github.event.workflow_run.head_sha }} |
||||
|
SMOKESHOW_AUTH_KEY: ${{ secrets.SMOKESHOW_AUTH_KEY }} |
||||
@ -0,0 +1,44 @@ |
|||||
|
# See https://pre-commit.com for more information |
||||
|
# See https://pre-commit.com/hooks.html for more hooks |
||||
|
repos: |
||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks |
||||
|
rev: v4.3.0 |
||||
|
hooks: |
||||
|
- id: check-added-large-files |
||||
|
- id: check-toml |
||||
|
- id: check-yaml |
||||
|
args: |
||||
|
- --unsafe |
||||
|
- id: end-of-file-fixer |
||||
|
- id: trailing-whitespace |
||||
|
- repo: https://github.com/asottile/pyupgrade |
||||
|
rev: v3.2.2 |
||||
|
hooks: |
||||
|
- id: pyupgrade |
||||
|
args: |
||||
|
- --py3-plus |
||||
|
- --keep-runtime-typing |
||||
|
- repo: https://github.com/charliermarsh/ruff-pre-commit |
||||
|
rev: v0.0.138 |
||||
|
hooks: |
||||
|
- id: ruff |
||||
|
args: |
||||
|
- --fix |
||||
|
- repo: https://github.com/pycqa/isort |
||||
|
rev: 5.10.1 |
||||
|
hooks: |
||||
|
- id: isort |
||||
|
name: isort (python) |
||||
|
- id: isort |
||||
|
name: isort (cython) |
||||
|
types: [cython] |
||||
|
- id: isort |
||||
|
name: isort (pyi) |
||||
|
types: [pyi] |
||||
|
- repo: https://github.com/psf/black |
||||
|
rev: 22.10.0 |
||||
|
hooks: |
||||
|
- id: black |
||||
|
ci: |
||||
|
autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks |
||||
|
autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate |
||||
@ -0,0 +1,466 @@ |
|||||
|
|
||||
|
{!../../../docs/missing-translation.md!} |
||||
|
|
||||
|
|
||||
|
<p align="center"> |
||||
|
<a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a> |
||||
|
</p> |
||||
|
<p align="center"> |
||||
|
<em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em> |
||||
|
</p> |
||||
|
<p align="center"> |
||||
|
<a href="https://github.com/tiangolo/fastapi/actions?query=workflow%3ATest" target="_blank"> |
||||
|
<img src="https://github.com/tiangolo/fastapi/workflows/Test/badge.svg" alt="Test"> |
||||
|
</a> |
||||
|
<a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank"> |
||||
|
<img src="https://img.shields.io/codecov/c/github/tiangolo/fastapi?color=%2334D058" alt="Coverage"> |
||||
|
</a> |
||||
|
<a href="https://pypi.org/project/fastapi" target="_blank"> |
||||
|
<img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version"> |
||||
|
</a> |
||||
|
</p> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
**Documentation**: <a href="https://fastapi.tiangolo.com" target="_blank">https://fastapi.tiangolo.com</a> |
||||
|
|
||||
|
**Source Code**: <a href="https://github.com/tiangolo/fastapi" target="_blank">https://github.com/tiangolo/fastapi</a> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
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: |
||||
|
|
||||
|
* **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance). |
||||
|
|
||||
|
* **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. <abbr title="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: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (previously known as Swagger) and <a href="https://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> |
||||
|
|
||||
|
## Sponsors |
||||
|
|
||||
|
<!-- sponsors --> |
||||
|
|
||||
|
{% if sponsors %} |
||||
|
{% for sponsor in sponsors.gold -%} |
||||
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
||||
|
{% endfor -%} |
||||
|
{%- for sponsor in sponsors.silver -%} |
||||
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
||||
|
{% endfor %} |
||||
|
{% endif %} |
||||
|
|
||||
|
<!-- /sponsors --> |
||||
|
|
||||
|
<a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">Other sponsors</a> |
||||
|
|
||||
|
## Opinions |
||||
|
|
||||
|
"_[...] 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._" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong> <a href="https://eng.uber.com/ludwig-v0-2/" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_**Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**! [built with **FastAPI**]_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Kevin Glisson, Marc Vilanova, Forest Monsen - <strong>Netflix</strong> <a href="https://netflixtechblog.com/introducing-dispatch-da4b8a2a8072" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_I’m over the moon excited about **FastAPI**. It’s so fun!_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_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._" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_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 [...]_" |
||||
|
|
||||
|
"_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> founders - <a href="https://spacy.io" target="_blank">spaCy</a> creators</strong> <a href="https://twitter.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://twitter.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## **Typer**, the FastAPI of CLIs |
||||
|
|
||||
|
<a href="https://typer.tiangolo.com" target="_blank"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a> |
||||
|
|
||||
|
If you are building a <abbr title="Command Line Interface">CLI</abbr> app to be used in the terminal instead of a web API, check out <a href="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**. ⌨️ 🚀 |
||||
|
|
||||
|
## Requirements |
||||
|
|
||||
|
Python 3.7+ |
||||
|
|
||||
|
FastAPI stands on the shoulders of giants: |
||||
|
|
||||
|
* <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a> for the web parts. |
||||
|
* <a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a> for the data parts. |
||||
|
|
||||
|
## Installation |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ pip install fastapi |
||||
|
|
||||
|
---> 100% |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
You will also need an ASGI server, for production such as <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> or <a href="https://gitlab.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>. |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ pip install "uvicorn[standard]" |
||||
|
|
||||
|
---> 100% |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
## Example |
||||
|
|
||||
|
### Create it |
||||
|
|
||||
|
* Create a file `main.py` with: |
||||
|
|
||||
|
```Python |
||||
|
from typing import Optional |
||||
|
|
||||
|
from fastapi import FastAPI |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
def read_root(): |
||||
|
return {"Hello": "World"} |
||||
|
|
||||
|
|
||||
|
@app.get("/items/{item_id}") |
||||
|
def read_item(item_id: int, q: Optional[str] = None): |
||||
|
return {"item_id": item_id, "q": q} |
||||
|
``` |
||||
|
|
||||
|
<details markdown="1"> |
||||
|
<summary>Or use <code>async def</code>...</summary> |
||||
|
|
||||
|
If your code uses `async` / `await`, use `async def`: |
||||
|
|
||||
|
```Python hl_lines="9 14" |
||||
|
from typing import Optional |
||||
|
|
||||
|
from fastapi import FastAPI |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
async def read_root(): |
||||
|
return {"Hello": "World"} |
||||
|
|
||||
|
|
||||
|
@app.get("/items/{item_id}") |
||||
|
async def read_item(item_id: int, q: Optional[str] = None): |
||||
|
return {"item_id": item_id, "q": q} |
||||
|
``` |
||||
|
|
||||
|
**Note**: |
||||
|
|
||||
|
If you don't know, check the _"In a hurry?"_ section about <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` and `await` in the docs</a>. |
||||
|
|
||||
|
</details> |
||||
|
|
||||
|
### Run it |
||||
|
|
||||
|
Run the server with: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ uvicorn main:app --reload |
||||
|
|
||||
|
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> |
||||
|
|
||||
|
<details markdown="1"> |
||||
|
<summary>About the command <code>uvicorn main:app --reload</code>...</summary> |
||||
|
|
||||
|
The command `uvicorn main:app` refers to: |
||||
|
|
||||
|
* `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. |
||||
|
|
||||
|
</details> |
||||
|
|
||||
|
### Check it |
||||
|
|
||||
|
Open your browser at <a href="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: |
||||
|
|
||||
|
```JSON |
||||
|
{"item_id": 5, "q": "somequery"} |
||||
|
``` |
||||
|
|
||||
|
You already created an API that: |
||||
|
|
||||
|
* 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`. |
||||
|
|
||||
|
### Interactive API docs |
||||
|
|
||||
|
Now go to <a href="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 <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>): |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### Alternative API docs |
||||
|
|
||||
|
And now, go to <a href="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 <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>): |
||||
|
|
||||
|
 |
||||
|
|
||||
|
## Example upgrade |
||||
|
|
||||
|
Now modify the file `main.py` to receive a body from a `PUT` request. |
||||
|
|
||||
|
Declare the body using standard Python types, thanks to Pydantic. |
||||
|
|
||||
|
```Python hl_lines="4 9-12 25-27" |
||||
|
from typing import Optional |
||||
|
|
||||
|
from fastapi import FastAPI |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class Item(BaseModel): |
||||
|
name: str |
||||
|
price: float |
||||
|
is_offer: Optional[bool] = None |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
def read_root(): |
||||
|
return {"Hello": "World"} |
||||
|
|
||||
|
|
||||
|
@app.get("/items/{item_id}") |
||||
|
def read_item(item_id: int, q: Optional[str] = None): |
||||
|
return {"item_id": item_id, "q": q} |
||||
|
|
||||
|
|
||||
|
@app.put("/items/{item_id}") |
||||
|
def update_item(item_id: int, item: Item): |
||||
|
return {"item_name": item.name, "item_id": item_id} |
||||
|
``` |
||||
|
|
||||
|
The server should reload automatically (because you added `--reload` to the `uvicorn` command above). |
||||
|
|
||||
|
### Interactive API docs upgrade |
||||
|
|
||||
|
Now go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>. |
||||
|
|
||||
|
* The interactive API documentation will be automatically updated, including the new body: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
* Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
* 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: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### Alternative API docs upgrade |
||||
|
|
||||
|
And now, go to <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>. |
||||
|
|
||||
|
* The alternative documentation will also reflect the new query parameter and body: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### Recap |
||||
|
|
||||
|
In summary, you declare **once** the types of parameters, body, etc. as function parameters. |
||||
|
|
||||
|
You do that with standard modern Python types. |
||||
|
|
||||
|
You don't have to learn a new syntax, the methods or classes of a specific library, etc. |
||||
|
|
||||
|
Just standard **Python 3.6+**. |
||||
|
|
||||
|
For example, for an `int`: |
||||
|
|
||||
|
```Python |
||||
|
item_id: int |
||||
|
``` |
||||
|
|
||||
|
or for a more complex `Item` model: |
||||
|
|
||||
|
```Python |
||||
|
item: Item |
||||
|
``` |
||||
|
|
||||
|
...and with that single declaration you get: |
||||
|
|
||||
|
* 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. |
||||
|
* <abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr> of input data: coming from the network to Python data and types. Reading from: |
||||
|
* JSON. |
||||
|
* Path parameters. |
||||
|
* Query parameters. |
||||
|
* Cookies. |
||||
|
* Headers. |
||||
|
* Forms. |
||||
|
* Files. |
||||
|
* <abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr> of output data: converting from Python data and types to network data (as JSON): |
||||
|
* Convert Python types (`str`, `int`, `float`, `bool`, `list`, etc). |
||||
|
* `datetime` objects. |
||||
|
* `UUID` objects. |
||||
|
* Database models. |
||||
|
* ...and many more. |
||||
|
* Automatic interactive API documentation, including 2 alternative user interfaces: |
||||
|
* 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. |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
We just scratched the surface, but you already get the idea of how it all works. |
||||
|
|
||||
|
Try changing the line with: |
||||
|
|
||||
|
```Python |
||||
|
return {"item_name": item.name, "item_id": item_id} |
||||
|
``` |
||||
|
|
||||
|
...from: |
||||
|
|
||||
|
```Python |
||||
|
... "item_name": item.name ... |
||||
|
``` |
||||
|
|
||||
|
...to: |
||||
|
|
||||
|
```Python |
||||
|
... "item_price": item.price ... |
||||
|
``` |
||||
|
|
||||
|
...and see how your editor will auto-complete the attributes and know their types: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
For a more complete example including more features, see the <a href="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>. |
||||
|
|
||||
|
**Spoiler alert**: the tutorial - user guide includes: |
||||
|
|
||||
|
* 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 **<abbr title="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: |
||||
|
* **WebSockets** |
||||
|
* **GraphQL** |
||||
|
* extremely easy tests based on `requests` and `pytest` |
||||
|
* **CORS** |
||||
|
* **Cookie Sessions** |
||||
|
* ...and more. |
||||
|
|
||||
|
## Performance |
||||
|
|
||||
|
Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as <a href="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). (*) |
||||
|
|
||||
|
To understand more about it, see the section <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>. |
||||
|
|
||||
|
## Optional Dependencies |
||||
|
|
||||
|
Used by Pydantic: |
||||
|
|
||||
|
* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - for faster JSON <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>. |
||||
|
* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email_validator</code></a> - for email validation. |
||||
|
|
||||
|
Used by Starlette: |
||||
|
|
||||
|
* <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - Required if you want to use the `TestClient`. |
||||
|
* <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration. |
||||
|
* <a href="https://andrew-d.github.io/python-multipart/" target="_blank"><code>python-multipart</code></a> - Required if you want to support form <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with `request.form()`. |
||||
|
* <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support. |
||||
|
* <a href="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). |
||||
|
* <a href="https://graphene-python.org/" target="_blank"><code>graphene</code></a> - Required for `GraphQLApp` support. |
||||
|
* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`. |
||||
|
|
||||
|
Used by FastAPI / Starlette: |
||||
|
|
||||
|
* <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application. |
||||
|
* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`. |
||||
|
|
||||
|
You can install all of these with `pip install fastapi[all]`. |
||||
|
|
||||
|
## License |
||||
|
|
||||
|
This project is licensed under the terms of the MIT license. |
||||
@ -0,0 +1,267 @@ |
|||||
|
# Generate Clients |
||||
|
|
||||
|
As **FastAPI** is based on the OpenAPI specification, you get automatic compatibility with many tools, including the automatic API docs (provided by Swagger UI). |
||||
|
|
||||
|
One particular advantage that is not necessarily obvious is that you can **generate clients** (sometimes called <abbr title="Software Development Kits">**SDKs**</abbr> ) for your API, for many different **programming languages**. |
||||
|
|
||||
|
## OpenAPI Client Generators |
||||
|
|
||||
|
There are many tools to generate clients from **OpenAPI**. |
||||
|
|
||||
|
A common tool is <a href="https://openapi-generator.tech/" class="external-link" target="_blank">OpenAPI Generator</a>. |
||||
|
|
||||
|
If you are building a **frontend**, a very interesting alternative is <a href="https://github.com/ferdikoomen/openapi-typescript-codegen" class="external-link" target="_blank">openapi-typescript-codegen</a>. |
||||
|
|
||||
|
## Generate a TypeScript Frontend Client |
||||
|
|
||||
|
Let's start with a simple FastAPI application: |
||||
|
|
||||
|
=== "Python 3.6 and above" |
||||
|
|
||||
|
```Python hl_lines="9-11 14-15 18 19 23" |
||||
|
{!> ../../../docs_src/generate_clients/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
=== "Python 3.9 and above" |
||||
|
|
||||
|
```Python hl_lines="7-9 12-13 16-17 21" |
||||
|
{!> ../../../docs_src/generate_clients/tutorial001_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
Notice that the *path operations* define the models they use for request payload and response payload, using the models `Item` and `ResponseMessage`. |
||||
|
|
||||
|
### API Docs |
||||
|
|
||||
|
If you go to the API docs, you will see that it has the **schemas** for the data to be sent in requests and received in responses: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image01.png"> |
||||
|
|
||||
|
You can see those schemas because they were declared with the models in the app. |
||||
|
|
||||
|
That information is available in the app's **OpenAPI schema**, and then shown in the API docs (by Swagger UI). |
||||
|
|
||||
|
And that same information from the models that is included in OpenAPI is what can be used to **generate the client code**. |
||||
|
|
||||
|
### Generate a TypeScript Client |
||||
|
|
||||
|
Now that we have the app with the models, we can generate the client code for the frontend. |
||||
|
|
||||
|
#### Install `openapi-typescript-codegen` |
||||
|
|
||||
|
You can install `openapi-typescript-codegen` in your frontend code with: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ npm install openapi-typescript-codegen --save-dev |
||||
|
|
||||
|
---> 100% |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
#### Generate Client Code |
||||
|
|
||||
|
To generate the client code you can use the command line application `openapi` that would now be installed. |
||||
|
|
||||
|
Because it is installed in the local project, you probably wouldn't be able to call that command directly, but you would put it on your `package.json` file. |
||||
|
|
||||
|
It could look like this: |
||||
|
|
||||
|
```JSON hl_lines="7" |
||||
|
{ |
||||
|
"name": "frontend-app", |
||||
|
"version": "1.0.0", |
||||
|
"description": "", |
||||
|
"main": "index.js", |
||||
|
"scripts": { |
||||
|
"generate-client": "openapi --input http://localhost:8000/openapi.json --output ./src/client --client axios" |
||||
|
}, |
||||
|
"author": "", |
||||
|
"license": "", |
||||
|
"devDependencies": { |
||||
|
"openapi-typescript-codegen": "^0.20.1", |
||||
|
"typescript": "^4.6.2" |
||||
|
} |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
After having that NPM `generate-client` script there, you can run it with: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ npm run generate-client |
||||
|
|
||||
|
[email protected] generate-client /home/user/code/frontend-app |
||||
|
> openapi --input http://localhost:8000/openapi.json --output ./src/client --client axios |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
That command will generate code in `./src/client` and will use `axios` (the frontend HTTP library) internally. |
||||
|
|
||||
|
### Try Out the Client Code |
||||
|
|
||||
|
Now you can import and use the client code, it could look like this, notice that you get autocompletion for the methods: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image02.png"> |
||||
|
|
||||
|
You will also get autocompletion for the payload to send: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image03.png"> |
||||
|
|
||||
|
!!! tip |
||||
|
Notice the autocompletion for `name` and `price`, that was defined in the FastAPI application, in the `Item` model. |
||||
|
|
||||
|
You will have inline errors for the data that you send: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image04.png"> |
||||
|
|
||||
|
The response object will also have autocompletion: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image05.png"> |
||||
|
|
||||
|
## FastAPI App with Tags |
||||
|
|
||||
|
In many cases your FastAPI app will be bigger, and you will probably use tags to separate different groups of *path operations*. |
||||
|
|
||||
|
For example, you could have a section for **items** and another section for **users**, and they could be separated by tags: |
||||
|
|
||||
|
|
||||
|
=== "Python 3.6 and above" |
||||
|
|
||||
|
```Python hl_lines="23 28 36" |
||||
|
{!> ../../../docs_src/generate_clients/tutorial002.py!} |
||||
|
``` |
||||
|
|
||||
|
=== "Python 3.9 and above" |
||||
|
|
||||
|
```Python hl_lines="21 26 34" |
||||
|
{!> ../../../docs_src/generate_clients/tutorial002_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
### Generate a TypeScript Client with Tags |
||||
|
|
||||
|
If you generate a client for a FastAPI app using tags, it will normally also separate the client code based on the tags. |
||||
|
|
||||
|
This way you will be able to have things ordered and grouped correctly for the client code: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image06.png"> |
||||
|
|
||||
|
In this case you have: |
||||
|
|
||||
|
* `ItemsService` |
||||
|
* `UsersService` |
||||
|
|
||||
|
### Client Method Names |
||||
|
|
||||
|
Right now the generated method names like `createItemItemsPost` don't look very clean: |
||||
|
|
||||
|
```TypeScript |
||||
|
ItemsService.createItemItemsPost({name: "Plumbus", price: 5}) |
||||
|
``` |
||||
|
|
||||
|
...that's because the client generator uses the OpenAPI internal **operation ID** for each *path operation*. |
||||
|
|
||||
|
OpenAPI requires that each operation ID is unique across all the *path operations*, so FastAPI uses the **function name**, the **path**, and the **HTTP method/operation** to generate that operation ID, because that way it can make sure that the operation IDs are unique. |
||||
|
|
||||
|
But I'll show you how to improve that next. 🤓 |
||||
|
|
||||
|
## Custom Operation IDs and Better Method Names |
||||
|
|
||||
|
You can **modify** the way these operation IDs are **generated** to make them simpler and have **simpler method names** in the clients. |
||||
|
|
||||
|
In this case you will have to ensure that each operation ID is **unique** in some other way. |
||||
|
|
||||
|
For example, you could make sure that each *path operation* has a tag, and then generate the operation ID based on the **tag** and the *path operation* **name** (the function name). |
||||
|
|
||||
|
### Custom Generate Unique ID Function |
||||
|
|
||||
|
FastAPI uses a **unique ID** for each *path operation*, it is used for the **operation ID** and also for the names of any needed custom models, for requests or responses. |
||||
|
|
||||
|
You can customize that function. It takes an `APIRoute` and outputs a string. |
||||
|
|
||||
|
For example, here it is using the first tag (you will probably have only one tag) and the *path operation* name (the function name). |
||||
|
|
||||
|
You can then pass that custom function to **FastAPI** as the `generate_unique_id_function` parameter: |
||||
|
|
||||
|
=== "Python 3.6 and above" |
||||
|
|
||||
|
```Python hl_lines="8-9 12" |
||||
|
{!> ../../../docs_src/generate_clients/tutorial003.py!} |
||||
|
``` |
||||
|
|
||||
|
=== "Python 3.9 and above" |
||||
|
|
||||
|
```Python hl_lines="6-7 10" |
||||
|
{!> ../../../docs_src/generate_clients/tutorial003_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
### Generate a TypeScript Client with Custom Operation IDs |
||||
|
|
||||
|
Now if you generate the client again, you will see that it has the improved method names: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image07.png"> |
||||
|
|
||||
|
As you see, the method names now have the tag and then the function name, now they don't include information from the URL path and the HTTP operation. |
||||
|
|
||||
|
### Preprocess the OpenAPI Specification for the Client Generator |
||||
|
|
||||
|
The generated code still has some **duplicated information**. |
||||
|
|
||||
|
We already know that this method is related to the **items** because that word is in the `ItemsService` (taken from the tag), but we still have the tag name prefixed in the method name too. 😕 |
||||
|
|
||||
|
We will probably still want to keep it for OpenAPI in general, as that will ensure that the operation IDs are **unique**. |
||||
|
|
||||
|
But for the generated client we could **modify** the OpenAPI operation IDs right before generating the clients, just to make those method names nicer and **cleaner**. |
||||
|
|
||||
|
We could download the OpenAPI JSON to a file `openapi.json` and then we could **remove that prefixed tag** with a script like this: |
||||
|
|
||||
|
```Python |
||||
|
{!../../../docs_src/generate_clients/tutorial004.py!} |
||||
|
``` |
||||
|
|
||||
|
With that, the operation IDs would be renamed from things like `items-get_items` to just `get_items`, that way the client generator can generate simpler method names. |
||||
|
|
||||
|
### Generate a TypeScript Client with the Preprocessed OpenAPI |
||||
|
|
||||
|
Now as the end result is in a file `openapi.json`, you would modify the `package.json` to use that local file, for example: |
||||
|
|
||||
|
```JSON hl_lines="7" |
||||
|
{ |
||||
|
"name": "frontend-app", |
||||
|
"version": "1.0.0", |
||||
|
"description": "", |
||||
|
"main": "index.js", |
||||
|
"scripts": { |
||||
|
"generate-client": "openapi --input ./openapi.json --output ./src/client --client axios" |
||||
|
}, |
||||
|
"author": "", |
||||
|
"license": "", |
||||
|
"devDependencies": { |
||||
|
"openapi-typescript-codegen": "^0.20.1", |
||||
|
"typescript": "^4.6.2" |
||||
|
} |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
After generating the new client, you would now have **clean method names**, with all the **autocompletion**, **inline errors**, etc: |
||||
|
|
||||
|
<img src="/img/tutorial/generate-clients/image08.png"> |
||||
|
|
||||
|
## Benefits |
||||
|
|
||||
|
When using the automatically generated clients you would **autocompletion** for: |
||||
|
|
||||
|
* Methods. |
||||
|
* Request payloads in the body, query parameters, etc. |
||||
|
* Response payloads. |
||||
|
|
||||
|
You would also have **inline errors** for everything. |
||||
|
|
||||
|
And whenever you update the backend code, and **regenerate** the frontend, it would have any new *path operations* available as methods, the old ones removed, and any other change would be reflected on the generated code. 🤓 |
||||
|
|
||||
|
This also means that if something changed it will be **reflected** on the client code automatically. And if you **build** the client it will error out if you have any **mismatch** in the data used. |
||||
|
|
||||
|
So, you would **detect many errors** very early in the development cycle instead of having to wait for the errors to show up to your final users in production and then trying to debug where the problem is. ✨ |
||||
|
After Width: | Height: | Size: 199 KiB |
|
After Width: | Height: | Size: 163 KiB |
|
After Width: | Height: | Size: 169 KiB |
|
After Width: | Height: | Size: 160 KiB |
|
After Width: | Height: | Size: 156 KiB |
|
After Width: | Height: | Size: 161 KiB |
|
After Width: | Height: | Size: 166 KiB |
|
After Width: | Height: | Size: 221 KiB |
|
After Width: | Height: | Size: 199 KiB |
|
After Width: | Height: | Size: 165 KiB |
|
After Width: | Height: | Size: 214 KiB |
|
After Width: | Height: | Size: 181 KiB |
|
After Width: | Height: | Size: 153 KiB |
|
After Width: | Height: | Size: 36 KiB |
|
After Width: | Height: | Size: 5.2 KiB |
|
After Width: | Height: | Size: 6.1 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
After Width: | Height: | Size: 127 KiB |
|
After Width: | Height: | Size: 52 KiB |
|
After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 159 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 9.5 KiB |
|
After Width: | Height: | Size: 22 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 76 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 49 KiB |
|
After Width: | Height: | Size: 29 KiB |
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue