Em vez de um prefácio, . , , . . , , . , copy/paste , . , .
:
, , HTTP API, POST , , . FastAPI, ?
Quem é o FastAPI?
O FastAPI é uma estrutura para criar servidores API API concisos e razoavelmente rápidos, com validação, serialização e assincronia incorporadas,
como se costuma dizer, prontas para uso . Ele está nos ombros das outras duas estruturas: o trabalho com a Web na FastAPI envolveu a Starlette e é responsável pela validação do Pydantic .
A ceifeira acabou por ser leve, não sobrecarregada e mais do que suficiente em funcionalidade.
Mínimo requerido
O FastAPI exige que um servidor ASGI funcione; por padrão, a documentação oferece uvcorn , com base no uvloop ; no entanto, o FastAPI também pode trabalhar com outros servidores, por exemplo, c hypercorn
Aqui estão minhas dependências:
[packages]
fastapi = "*"
uvicorn = "*"
E isso é mais do que suficiente.
Para leitores mais detalhados, no final do artigo, há um link para o repositório com um bot, no qual é possível examinar as dependências para desenvolvimento e teste.
Bem, nós pipenv install -d
começamos!
Crie a API
Deve-se notar que a abordagem para projetar manipuladores no FastAPI é extremamente semelhante à do Flask, Bottle e milhares deles. Aparentemente, milhões de moscas não podem estar erradas.
Na primeira aproximação, minha rota de processamento de lançamento era assim:
from fastapi import FastAPI
from starlette import status
from starlette.responses import Response
from models import Body
app = FastAPI()
@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 = {}
if settings.ENVIRONMENT == 'production':
docs_kwargs = dict(docs_url=None, redoc_url=None)
app = FastAPI(**docs_kwargs)
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()
@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
O relatório acabou, obrigado a todos!