fastapi-patterns

Topics in the source

• FastAPIパターン
• 使用するタイミング
• 仕組み
• プロジェクトレイアウト
• アプリケーションファクトリー
• Pydanticスキーマ
• 依存関係
• 非同期エンドポイント

本番指向のFastAPIサービスのためのパターン。 FastAPIアプリを構築またはレビューする場合。 ルーター、スキーマ、依存関係、データベースアクセスを分割する場合。 データベースや外部サービスを呼び出す非同期エンドポイントを記述する場合。 認証、認可、OpenAPIドキュメント、テスト、またはデプロイ設定を追加する場合。 FastAPI PRをコピー可能な例とリスクについて確認する場合。 FastAPIアプリを明示的な依存関係とサービスコードの上の薄いHTTPレイヤーとして扱います: main.py はアプリ構築、ミドルウェア、例外ハンドラー、ルーター登録を担当する。 schemas/ はPydanticのリクエストとレスポンスモデルを担当する。 dependencies.py はデータベース、認証、ページネーション、リクエストスコープの依存関係を担当する。 services/ または crud/ はビジネスと永続化操作を担当する。 tests/ は本番リソースを開かずに依存関係をオーバーライドする。 小さなルーターと明示的なresponsemodel宣言を優先します。レスポンススキーマには生のORMオブジェクト、シークレット、フレームワークのグローバル変数を含めないでください。 テストとワーカーが制御された設定でアプリをビルドできるように、ファクトリーを使用します。 allowcredentials=Trueと一緒にalloworigins=[""]を使用しないでください; ブラウザはその組み合わせを拒否し、Starletteは認証情報付きリクエストに対してそれを禁止します。 リクエスト、更新、レスポンスのモデルを分離します。 レスポンスモデルにはパスワードハッシュ、アクセストークン、リフレッシュトークン、内部認可状態を含めてはなりません。 リクエストスコープのリソースには依存性注入を使用します。 ルートハンドラー内でインラインにセッション、クライアント、または認証情報を作成しないでください。 I/Oを実行する場合はルートハンドラーを非同期にし、その内部で非同期ライブラリを使用します。 非同期ハンドラーからの外部HTTP呼び出しにはhttpx.AsyncClientを使用してください。非同期ルートでrequestsを呼び出さないでください。 ドメイン例外を一元化し、レスポンスの形状を安定させます。 カスタムOpenAPI呼び出し可能オブジェクトをapp.openapiに割り当ててください; 関数を一度だけ呼び出さないでください。 ルートハンドラーが決して参照しない内部ヘルパーではなく、Dependsで使用される依存関係をオーバーライドします。 argon2-cffi、bcrypt、または現在のpasslib互換ハッシャーでパスワードをハッシュする。

This is an excerpt. Refer to the complete source and its current requirements.