start fastapi

Start-Fastapi

Starletteフレームワークで開発された使いやすいWebアプリであるFastapiに基づくバージョン2021

• バージョン2020
• 中文文档

要件

• Python 3.6+（静的タイピングチェック用）
• pip3 install -r ./requirements.txt
  • Fastapi、Uvicorn、Python-Dotenv、Python-Multipart、WebSocketsなど
• Idea/pycharm（推奨） + venv

構造

Webアプリケーションは、オニオンスタイル〜に基づいています

ディレクトリ構造は次のとおりです。

• アプリ：アプリケーションのロジックには、ユーザーモジュールのエントリとして__init__.pyが含まれています
  • ハンドラー：コントローラー
  • ミドルウェア：corsのようなルーターミドルウェア
  • モデル：基本的なデータモデルと内部ロジック
  • サービス：外部ロジック（ユーザーへ）
• CFG：異なるenvsの構成
  • 開発：dev envの構成
    • App.CFG：FastapiのPython-Dotenv CFG
    • uvicorn.json：uvicorn asgiサーバーのCFG、Fastapiのランチャー
    • logger.json：uvicornのCFGのロギング
  • PROD：生産の構成env
• コア：低レベルのライブラリとロジックには、コアモジュールのエントリとして__init__.pyが含まれているため、他のプロジェクトで再利用できるようになります
  • ハンドラ
  • LIB：ユーザーがロジックを作成するためのショートカットAPI
  • モデル
  • サービス
    • トランス：バックグラウンドで実行されているタスクを管理するためのトランザクションサービス
• その他：その他の部品、ビルド、テストスクリプトなど
  • ビルド：ビルドスクリプト
  • 開発者：DEV使用のためのリソース
    • gen_code.py：コードを生成するためのスクリプト
  • Doc：docs
  • テスト：テストスクリプト
• Main.py：メインエントリ、init uvicorn、およびStart fastapiアプリ
• 要件：pyパッケージ要件

クイックスタート

アプリサーバーを起動します

./main.pyを実行して、例を開始します。

• コアモジュール：ヘルスチェックハンドラー、基本モデル、トランザクションサービス
• ワイルドカードで構成されたCORSミドルウェア *
• テストハンドラー、モデル、およびサービス：製品や顧客との単純な市場貿易システムをシミュレートする
  • WebSocketとアップロードファイルの例は、テストハンドラーにも含まれています

内部の手順は次のとおりです。

• ./main.py cmd argsの内部​​で構成が./cfg/{env}を読み込んでから、 uvicorn.runを呼び出して、fastapiアプリを./app/__init__.pyで開始します
• ./app/__init__.pyで、コアモジュールとユーザーハンドラー/モデル/サービスは、Fastapiアプリのstartupイベントでロードされます

起動スクリプトを内部に配置できます./misc/build

コーディングガイド

ロジックを構築するには、一般的な手順が次のとおりです。

• ./main.pyデフォルトで開発環境でサーバーを実行します。ホットレロードが有効になっています
• ./app/handlerにハンドラーを追加し、対応するimport ＆ APP.include_routerコードを./app/__init__.pyに追加します
• ./app/modelにデータモデルを追加し、 ./app/service serviceにサービスを追加します
• 必要に応じて、 ./app/middleware middlewareにMiddleWaresを追加します

コーディングのためのいくつかのヒント：

• Webページでルーターをテストするために/docsを取得します
• メインのevtloopをブロックする可能性があるため、Coroutines（ async def関数）の使用を避けてください。 def関数は、異なるスレッドで呼び出されます
• ./coreのコードは共有可能である必要があります（他のプロジェクトの場合）、 ./app appのコードは現在のプロジェクトに適合する必要があります
• ./misc/dev/gen_code.py使用して、ハンドラー、モデル、サービスのテンプレートコードを生成できます。プロジェクトルートディレクトリとしてワーキングディレクトリを使用して実行します
• pydantic.BaseModelに基づくコードモデル、それは強力です

HTTP応答

処理された要求のほとんどには、200のステータスコードを含める必要があります

簡単な解決策は、 Respモデルを./core/model/handler.pyで使用して、ハンドラーの応答ボディを生成することです

 {
  "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を参照してください