start fastapi

start-fastapi

版本2021，基于FastApi，这是一个易于使用的Web应用程序

• 版本2020
• 中文文档

要求

• python 3.6+（用于静态键入检查）
• pip3 install -r ./requirements.txt
  • Fastapi，Uvicorn，Python-Dotenv，Python-Multipart，WebSockets等
• 创意/pycharm（推荐） + VENV

结构

Web应用程序基于洋葱样式〜

目录结构是：

• 应用：应用程序的逻辑，包括__init__.py作为用户模块的进入
  • 处理程序：控制器
  • 中间件：路由器中间件，像CORS一样
  • 模型：基本数据模型和内部逻辑
  • 服务：外部逻辑（给用户）
• CFG：不同Envs的配置
  • 开发：开发设备的配置
    • app.cfg：python-dotenv cfg for fastapi
    • Uvicorn.json：uvicorn asgi服务器的CFG，fastapi的启动器
    • logger.json：uvicorn的记录CFG
  • 产品：生产env的配置
• 核心：低级库和逻辑，包括__init__.py作为核心模块的进入，更好地使其能够在其他项目中重复使用
  • 处理程序
  • LIB：用户构建逻辑的快捷方式
  • 模型
  • 服务
    • trans：交易服务，用于管理在后台运行的任务
• 杂项：杂项零件，例如构建，测试脚本等
  • 构建：构建脚本
  • 开发人员：用于开发用法的资源
    • gen_code.py：用于生成代码的脚本
  • 文档：文档
  • 测试：测试脚本
• main.py：主条目，init uvicorn并启动fastapi应用程序
• 要求：py套餐要求

快速开始

启动应用程序服务器

运行./main.py启动示例，其中包括：

• 核心模块：健康检查处理程序，基本模型，交易服务
• 用通配符配置的CORS中间件 *
• 测试处理程序，模型和服务：使用产品和客户模拟简单的市场贸易系统
  • Websocket和上传文件的示例也包括在测试处理程序中

内部步骤是：

• ./main.py在./app/__init__.py args上加载./cfg/{env}内部uvicorn.run配置
• in ./app/__init__.py Modules和用户处理程序/模型/服务已在Fastapi App的startup活动中加载

您可以将启动脚本放入内部./misc/build以获取不同的启动选项

编码指南

为了构建您的逻辑，以下是共同的步骤：

• ./main.py
• 在./app/handler中添加处理程序，添加相应的import ＆ APP.include_router codes in ./app/__init__.py
• 在./app/model中添加数据模型，在./app/service中添加服务
• 如有./app/middleware

一些编码技巧：

• 获取/docs在网页上测试路由器
• 避免使用Coroutines（ async def函数），因为它可能会阻止主evtloop，以免及时处理其他请求。 def函数将在不同的线程中调用
• ./core的代码应共享（对于其他项目）， ./app的代码应符合当前项目
• 您可以使用./misc/dev/gen_code.py来生成处理程序，模型和服务的模板代码。用工作目录作为项目根目录执行它
• 基于pydantic.BaseModel的代码模型，它功能强大

HTTP响应

大多数处理请求应包含200个状态代码

一个简单的解决方案是使用./core/model/handler.py中的Resp模型为您的处理程序生成响应主体

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

使用Resp.ok产生成功响应并使用Resp.err来产生错误响应

杂项

Websocket

测试处理程序./app/handler/test.py包含WS处理程序示例

要了解更多有关它的信息，请参阅Websocket文档

部署

运行./misc/build/pack.sh将项目打包到./misc/build/start-fastapi.tar.gz

有关Docker部署的示例，请参见./misc/build/Dockerfile