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