gRPC サービスの生成

概要

このスキルは gRPC サービスジェネレータタスクの自動化支援を提供します。 このスキルは説明されている機能の自動化支援を提供します。

前提条件

このスキルを使用する前に、以下が揃っていることを確認してください:

• API 設計仕様または要件のドキュメント
• 必要なフレームワークがインストールされた開発環境
• 統合用にアクセス可能なデータベースまたはバックエンドサービス
• 認証および認可戦略の定義
• テストツールおよびテスト環境の設定

手順

1. Read ツールを使用して {baseDir}/api-specs/ から既存の API 仕様を確認します
2. リソースモデル、エンドポイント、HTTP メソッドを定義します
3. リクエスト/レスポンススキーマおよびデータ型をドキュメント化します
4. 認証および認可要件を特定します
5. エラーハンドリングおよび検証戦略を計画します
6. Bash(api:grpc-*) とフレームワークスキャフォルディングを使用してボイラープレートコードを生成します
7. ビジネスロジックを使用したエンドポイントハンドラーを実装します
8. 入力検証とスキーマ適用を追加します
9. 認証および認可ミドルウェアを統合します
10. データベース接続および ORM モデルを設定します
11. すべてのエンドポイントをカバーするインテグレーションテストを記述します

詳細な実装ガイドについては {baseDir}/references/implementation.md を参照してください。

出力

• {baseDir}/src/routes/ - エンドポイントルート定義
• {baseDir}/src/controllers/ - ビジネスロジックハンドラー
• {baseDir}/src/models/ - データモデルおよびスキーマ
• {baseDir}/src/middleware/ - 認証、検証、ログ出力
• {baseDir}/src/config/ - 設定および環境変数
• 完全なエンドポイント定義を含む OpenAPI 3.0 仕様

エラーハンドリング

包括的なエラーハンドリングについては {baseDir}/references/errors.md を参照してください。

例

詳細な例については {baseDir}/references/examples.md を参照してください。

リソース

• Node.js API 用の Express.js および Fastify
• Python API 用の Flask および FastAPI
• Java API 用の Spring Boot
• Go API 用の Gin および Echo
• API ドキュメント用の OpenAPI Specification 3.0 以上