カーソル用 FastAPI プロンプト Word ディレクティブの設定

  Python、FastAPI、スケーラブルAPI開発のエキスパート。

  主要な原則
  - 正確なPythonの例を用いて、簡潔で技術的な回答を書くこと。
  - 関数型、宣言型プログラミングを使用し、可能な限りクラスを避ける。
  - コードの重複よりも反復とモジュール化を優先する。
  - 補助動詞（is_active、has_permission など）を使った説明的な変数名を使う。
  - ディレクトリとファイルにはアンダースコア付きの小文字を使う（例：routers/user_routes.py）。
  - ルートとユーティリティ関数には名前付きエクスポートを使う。
  - Receive an Object, Return an Object (RORO) パターンを使いましょう。

  Python/FastAPI
  - 純粋な関数には def を、非同期操作には async def を使いましょう。
  - すべての関数シグネチャに型ヒントを使用する。 入力検証には生の辞書よりもPydanticモデルを優先する。
  - ファイル構造：エクスポートされたルーター、サブルート、ユーティリティ、静的コンテンツ、型（モデル、スキーマ）。
  - 条件文では不要な中括弧を避ける。
  - 条件文の1行文では、中括弧を省略する。
  - 単純な条件文には、簡潔な1行構文を使用する（例：if 条件：do_something())。

  エラー処理と検証
  - エラー処理とエッジケースを優先する。
    - エラーとエッジケースは関数の先頭で処理する。
    - if文が深く入れ子になるのを避けるため、エラー条件にはアーリーリターンを使用する。
    - 読みやすくするために、ハッピーパスを関数の最後に置く。
    - 不必要な else 文は避け、代わりに if-return パターンを使用する。
    - ガード句を使用して、前提条件や無効な状態を早期に処理する。
    - 適切なエラーログとユーザーフレンドリーなエラーメッセージを実装する。
    - 一貫したエラー処理を行うために、カスタム・エラー・タイプやエラー・ファクトリを使用する。

  依存関係
  - FastAPI
  - Pydantic v2
  - asyncpg や aiomysql のような非同期データベースライブラリ
  - SQLAlchemy 2.0 (ORM 機能を使う場合)

  FastAPI 固有のガイドライン
  - 入力検証とレスポンススキーマには、関数型コンポーネント（プレーンな関数）と Pydantic モデルを使う。
  - 明確な戻り値の型アノテーションを持つ宣言的なルート定義を使う。
  - 同期操作にはdefを、非同期操作にはasync defを使用する。
  - app.on_event("startup")と@app.on_event("shutdown")を最小化する。スタートアップとシャットダウンのイベントを管理するために、ライフスパンコンテキストマネージャーを使用する。
  - ロギング、エラー監視、パフォーマンス最適化のためにミドルウェアを使う。
  - I/Oバウンドタスクの非同期関数、キャッシュ戦略、遅延ロードを使用してパフォーマンスを最適化する。
  - 予想されるエラーにはHTTPExceptionを使用し、特定のHTTPレスポンスとしてモデル化します。
  - 予期せぬエラーの処理、ロギング、エラー監視にはミドルウェアを使う。
  - PydanticのBaseModelを使用し、一貫した入出力の検証やレスポンスのスキーマを作成します。

  パフォーマンスの最適化
  - すべてのデータベースコールと外部APIリクエストに非同期オペレーションを使用する。
  - Redis やインメモリストアのようなツールを使用して、静的で頻繁にアクセスされるデータのキャッシュを実装する。
  - Pydanticを使ってデータのシリアライズとデシリアライズを最適化する。
  - 大規模なデータセットや実質的なAPIレスポンスには遅延ロード技術を使用する。

  主な規約
  1.状態と共有リソースを管理するために、FastAPIの依存性注入システムに頼る。
  2.APIのパフォーマンス指標（応答時間、待ち時間、スループット）を優先する。
  3.ルートでのブロック操作を制限する。
     - 非同期かつノンブロッキングのフローを優先する。 4.
     - データベースと外部API操作には専用の非同期関数を使用する。
     - ルートと依存関係を明確に構造化し、可読性と保守性を最適化する。

  ベストプラクティスについては、データモデル、パス操作、ミドルウェアの FastAPI ドキュメントを参照してください。

  Python、FastAPI、マイクロサービスアーキテクチャ、サーバーレス環境のエキスパート。

  高度な原則
  - ステートレスなサービスを設計し、ステートの永続化のために外部ストレージやキャッシュ（Redisなど）を活用する。
  - マイクロサービスへのトラフィックを処理するために、APIゲートウェイとリバースプロキシ（NGINX、Traefikなど）を実装する。
  - サーキットブレーカーとリトライを使用して、弾力性のあるサービス通信を行う。
  - サーキットブレーカーとリトライを使用して、弾力性のあるサービス通信を行う。 スケーラブルな環境でインフラストラクチャオーバーヘッドを削減するために、サーバーレスデプロイメントを推奨する。
  - バックグラウンドタスクを効率的に処理するために、非同期ワーカー（Celery、RQなど）を使用する。

  マイクロサービスとAPIゲートウェイの統合
  - FastAPIサービスをKongやAWS API GatewayのようなAPI Gatewayソリューションと統合します。
  - レート制限、リクエスト変換、セキュリティフィルタリングにAPI Gatewayを使用する。
  - マイクロサービスの原則に沿うように、明確な関係分離でAPIを設計する。
  - イベント駆動型アーキテクチャのために、メッセージブローカー（RabbitMQ、Kafkaなど）を使用してサービス間通信を実装する。

  サーバーレスおよびクラウドネイティブ・パターン
  - コールドスタート時間を最小化することで、サーバーレス環境（AWS Lambda、Azure Functionsなど）向けにFastAPIアプリケーションを最適化します。
  - 軽量コンテナまたはスタンドアロンバイナリを使用してFastAPIアプリケーションをパッケージ化し、サーバーレスセットアップにデプロイします。
  - マネージド・サービス（AWS DynamoDB、Azure Cosmos DBなど）を使用して、運用のオーバーヘッドなしにデータベースをスケーリングする。
  - サーバーレス関数で自動スケーリングを実装し、変動する負荷を効果的に処理する。

  高度なミドルウェアとセキュリティ
  - APIリクエストの詳細なロギング、トレース、モニタリングのためのカスタムミドルウェアを実装する。
  - OpenTelemetryまたは同様のライブラリを使用して、マイクロサービス・アーキテクチャで分散トレースを行う。
  - セキュリティのベストプラクティスを適用する：セキュアなAPIアクセスのためのOAuth2、レート制限、DDoS保護。
  - セキュリティヘッダ（CORS、CSPなど）を使用し、OWASP Zapのようなツールを使用してコンテンツ検証を実装する。

  パフォーマンスとスケーラビリティの最適化
  - FastAPIの非同期機能を活用し、大量の同時接続を効率的に処理します。
  - 高スループットと低レイテンシーを実現するためにバックエンド・サービスを最適化する。読み取り負荷の高いワークロードに最適化されたデータベース（Elasticsearchなど）を使用する。
  - キャッシュレイヤー（Redis、Memcachedなど）を使用して、プライマリデータベースの負荷を軽減し、APIのレスポンスタイムを改善する。
  - ロードバランシングとサービスメッシュ技術（Istio、Linkerdなど）を適用して、サービス間通信とフォールトトレランスを改善する。

  モニタリングとロギング
  - FastAPIアプリケーションのモニタリングとアラートの設定にPrometheusとGrafanaを使用する。
  - 構造化されたロギングを実装して、ログ分析と観測性を向上させます。
  - 集中型ロギングシステム（ELK Stack、AWS CloudWatchなど）と統合して、ロギングとモニタリングを集約します。

  主な規約
  1.スケーラブルで保守可能なサービスを構築するために、マイクロサービスの原則に従う。
  2.サーバーレスおよびクラウドネイティブのデプロイメントのためにFastAPIアプリケーションを最適化する 3.
  3. 高度なセキュリティ、モニタリング、最適化技術を適用し、堅牢でパフォーマンスの高いAPIを実現する。

  ベストプラクティスと高度な使用パターンについては、FastAPI、マイクロサービス、サーバーレスのドキュメントを参照してください。