Introduciendo FastAPI

¿Quién es FastAPI?

FastAPI es un marco para crear servidores API HTTP concisos y bastante rápidos con validación, serialización y asincronía incorporadas,
como dicen, listas para usar . Se apoya en los hombros de los otros dos marcos: el trabajo con la web en FastAPI contrató a Starlette , y es responsable de la validación Pydantic .

La cosechadora resultó ser ligera, no sobrecargada y más que suficiente en funcionalidad.

Mínimo requerido

FastAPI requiere un servidor ASGI para funcionar, por defecto la documentación ofrece uvcorn , basado en uvloop , sin embargo, FastAPI también puede funcionar con otros servidores, por ejemplo, c hypercorn

Aquí están mis dependencias:

[packages]
fastapi = "*"
uvicorn = "*"

Y esto es más que suficiente.

Para lectores más exhaustivos, al final del artículo hay un enlace al repositorio con un bot, donde puedes ver las dependencias para el desarrollo y las pruebas.

Bueno, pipenv install -dempezamos!

Construye la API

Cabe señalar que el enfoque para diseñar controladores en FastAPI es extremadamente similar al de Flask, Bottle y miles de ellos. Aparentemente, millones de moscas no pueden estar equivocadas.

En la primera aproximación, mi ruta de procesamiento de lanzamiento se veía así:

from fastapi import FastAPI
from starlette import status
from starlette.responses import Response

from models import Body

app = FastAPI()  # noqa: pylint=invalid-name

@app.post("/release/")
async def release(*,
                  body: Body,
                  chat_id: str = None):
    await proceed_release(body, chat_id)
    return Response(status_code=status.HTTP_200_OK)

, , , FastAPI Body, chat_id URL params

models.py:

from datetime import datetime
from enum import Enum

from pydantic import BaseModel, HttpUrl

class Author(BaseModel):
    login: str
    avatar_url: HttpUrl

class Release(BaseModel):
    name: str
    draft: bool = False
    tag_name: str
    html_url: HttpUrl
    author: Author
    created_at: datetime
    published_at: datetime = None
    body: str

class Body(BaseModel):
    action: str
    release: Release

, Pydantic. , , , :

class Body(BaseModel):
    action: str
    releases: List[Release]

FastAPI . . , - — .

Pydantic , HttpUrl, URL , FastAPI . Pydantic

.

FastAPI , , , ,
— !

FastAPI , :

from fastapi import FastAPI, HTTPException, Depends
from starlette import status
from starlette.requests import Request

import settings
from router import api_router
from utils import check_auth

docs_kwargs = {}  # noqa: pylint=invalid-name
if settings.ENVIRONMENT == 'production':
    docs_kwargs = dict(docs_url=None, redoc_url=None)  # noqa: pylint=invalid-name

app = FastAPI(**docs_kwargs)  # noqa: pylint=invalid-name

async def check_auth_middleware(request: Request):
    if settings.ENVIRONMENT in ('production', 'test'):
        body = await request.body()
        if not check_auth(body, request.headers.get('X-Hub-Signature', '')):
            raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED)

app.include_router(api_router, dependencies=[Depends(check_auth_middleware)])

, request.body — , . FastAPI( Starlette) , .

, FastAPI — OpenAPI Swagger/ReDoc , _/docs _/redoc .

. .

, :

from fastapi import APIRouter
from starlette import status
from starlette.responses import Response

from bot import proceed_release
from models import Body, Actions

api_router = APIRouter()  # noqa: pylint=invalid-name

@api_router.post("/release/")
async def release(*,
                  body: Body,
                  chat_id: str = None,
                  release_only: bool = False):

    if (body.release.draft and not release_only) \
            or body.action == Actions.released:
        res = await proceed_release(body, chat_id)
        return Response(status_code=res.status_code)
    return Response(status_code=status.HTTP_200_OK)

, HTTP API- , .

FastAPI — , , , . , (, , 2020- ?
), .

, , , , , FastAPI.

, , . — , , , , .

, , github actions

El informe ha terminado, ¡gracias a todos!