start fastapi

Start-Fastapi

Versão 2021, baseada no FASTAPI, um aplicativo web fácil de usar desenvolvido na estrutura Starlette

• Versão 2020
• 中文文档

Requisitos

• Python 3.6+ (para verificação de digitação estática)
• pip3 install -r ./requirements.txt
  • FASTAPI, UVICORN, Python-dotenv, Python-Multipart, Websockets, etc
• Ideia/PyCharm (recomendado) + Venv

Estrutura

O aplicativo da web é baseado no estilo de cebola ~

A estrutura do diretório é:

• App: Logics for Your Application, inclui __init__.py como entrada de módulos de usuário
  • Manipulador: Controladores
  • Middleware: Middleware do roteador, como CORS
  • Modelo: modelos de dados básicos e lógicas internas
  • Serviço: lógicas externas (para usuários)
• CFG: Config de diferentes Envs
  • Dev: Configs of Dev Env
    • App.cfg: python-dotenv cfg para fastapi
    • Uvicorn.json: CFG para Uvicorn Asgi Server, o lançador para FASTAPI
    • Logger.json: Logging CFG para Uvicorn
  • Prod: Configs of Production Env
• núcleo: bibliotecas e lógicas de baixo nível, inclui __init__.py como entrada de módulos principais, melhor tornam o fato de ser reutilizado em outros projetos
  • manipulador
  • Lib: APIs de atalho para o usuário criar lógicas
  • modelo
  • serviço
    • Trans: Serviço de Transação , para gerenciar tarefas em segundo plano
• Misc: Misc Parts, como Build, Test Scripts, etc
  • Construir: construir scripts
  • Dev: Recursos para o uso de desenvolvedores
    • gen_code.py: um script para gerar códigos
  • Doc: Docs
  • Teste: Scripts de teste
• Main.py: entrada principal, init uvicorn e start fastapi app
• requisitos.txt: requisitos de pacote py

Início rápido

Inicie o servidor de aplicativos

Run ./main.py para iniciar o exemplo, que inclui:

• Módulos principais: manipulador de cheques de saúde, modelos básicos, serviço de transação
• Middleware CORS configurado com curinga *
• Manipuladores de teste, modelos e serviço: simula um sistema de comércio de mercado simples com produtos e clientes
  • Exemplos de arquivo WebSocket e Upload também estão incluídos nos manipuladores de teste

As etapas internas são:

• ./main.py carrega as configurações dentro ./cfg/{env} no cmd args, então chama uvicorn.run para iniciar o aplicativo FASTAPI em ./app/__init__.py
• in ./app/__init__.py , módulos principais e manipuladores de usuários/modelos/serviços são carregados no evento startup do aplicativo FASTAPI

Você pode colocar seus scripts de lançamento dentro ./misc/build para suas diferentes opções de lançamento

Guia de codificação

Para construir sua lógica, são seguintes as etapas comuns:

• ./main.py executa o servidor no ambiente de dev em padrão, no qual a carga quente está habilitada
• import APP.include_router ./app/__init__.py ./app/handler
• Adicione modelos de dados em ./app/model , adicione serviços em ./app/service
• Adicione Middlewares em ./app/middleware se necessário

Algumas dicas para codificação:

• Obtenha /docs para testar os roteadores na página da web
• Evite o uso de coroutines (funções async def ), pois pode bloquear o principal EVTLOOP, para que outras solicitações não sejam tratadas no tempo. As funções def serão invocadas em diferentes tópicos
• Os códigos de ./core devem ser compartilháveis ​​(para outros projetos), os códigos de ./app devem se encaixar no projeto atual
• Você pode usar ./misc/dev/gen_code.py para gerar códigos de modelo para manipuladores, modelos e serviços. Executá -lo com o diretório de trabalho como diretório raiz do projeto
• Modelos de código baseados em pydantic.BaseModel , é poderoso

Resposta HTTP

A maioria dos pedidos manipulados deve conter um código de status de 200

Uma solução simples é usar o modelo Resp em ./core/model/handler.py para gerar corpo de resposta para seus manipuladores

 {
  "success": bool,
  "message": str,
  "code": IntEnum,
  "data": Any,
}

Use Resp.ok para gerar resposta de sucesso e usar Resp.err para gerar resposta de erro

Misc

WebSocket

O manipulador de teste ./app/handler/test.py contém exemplos de manipuladores WS

Para saber mais sobre isso, consulte a documentação do WebSocket

Implantação

Run ./misc/build/pack.sh para levar o projeto a ./misc/build/start-fastapi.tar.gz

Veja ./misc/build/Dockerfile para um exemplo de implantação do Docker