OpenAPI仕様からアプリケーションを生成

OpenAPI仕様を使用して、アクティブフレームワークの慣例とベストプラクティスに従った完全で動作するアプリケーションを生成することが目標です。

入力要件

1. OpenAPI仕様: 次のいずれかを提供してください:

   • OpenAPI仕様のURL (例: https://api.example.com/openapi.json)
   • OpenAPI仕様へのローカルファイルパス
   • OpenAPI仕様の完全な内容を直接貼り付け

2. プロジェクト詳細 (仕様に含まれていない場合):

   • プロジェクト名と説明
   • ターゲットフレームワークとバージョン
   • パッケージ/名前空間の命名規則
   • 認証方法 (OpenAPIで指定されていない場合)

生成プロセス

ステップ 1: OpenAPI仕様を分析

• OpenAPI仕様の完全性と正確性を検証
• すべてのエンドポイント、HTTPメソッド、リクエスト/レスポンス仕様を識別
• 認証要件とセキュリティスキームを抽出
• データモデルの関連性と制約を記録
• あいまいな定義や不完全な定義にフラグを付ける

ステップ 2: アプリケーションアーキテクチャを設計

• フレームワークに適したディレクトリ構造を計画
• リソースまたはドメイン別のコントローラー/ハンドラーグループを識別
• ビジネスロジック用のサービスレイヤー構成を設計
• データモデルとエンティティ関連性を計画
• 設定と初期化戦略を設計

ステップ 3: アプリケーションコードを生成

• ビルド/パッケージ設定ファイルを含むプロジェクト構造を作成
• OpenAPI仕様からモデル/DTOを生成
• ルートマッピング付きのコントローラー/ハンドラーを生成
• ビジネスロジック付きのサービスレイヤーを生成
• 必要に応じてリポジトリ/データアクセスレイヤーを生成
• エラーハンドリング、検証、ログを追加
• 設定とスタートアップコードを生成

ステップ 4: サポートファイルを追加

• サービスとコントローラー用の単体テストを生成
• セットアップと実行手順を含むREADMEを作成
• .gitignoreと環境設定テンプレートを追加
• API ドキュメントファイルを生成
• リクエスト例/統合テストを作成

出力構造

生成されたアプリケーションには以下が含まれます:

project-name/
├── README.md                      # セットアップと使用方法の説明
├── [build-config]                 # フレームワーク固有のビルドファイル (pom.xml, build.gradle, package.json など)
├── src/
│   ├── main/
│   │   ├── [language]/
│   │   │   ├── controllers/       # HTTPエンドポイントハンドラー
│   │   │   ├── services/          # ビジネスロジック
│   │   │   ├── models/            # データモデルとDTO
│   │   │   ├── repositories/      # データアクセス (必要に応じて)
│   │   │   └── config/            # アプリケーション設定
│   │   └── resources/             # 設定ファイル
│   └── test/
│       ├── [language]/
│       │   ├── controllers/       # コントローラーテスト
│       │   └── services/          # サービステスト
│       └── resources/             # テスト設定
├── .gitignore
├── .env.example                   # 環境変数テンプレート
└── docker-compose.yml             # オプション: Docker設定 (必要に応じて)

適用されるベストプラクティス

• フレームワーク慣例: フレームワーク固有の命名、構造、パターンに従う
• 関心の分離: コントローラー、サービス、リポジトリを明確に階層化
• エラーハンドリング: 意味のあるレスポンスを含む包括的なエラーハンドリング
• 検証: 全体にわたるInput検証とスキーマ検証
• ログ: デバッグと監視のための構造化ログ
• テスト: サービスとコントローラー用の単体テスト
• ドキュメント: インラインコードドキュメントとセットアップ手順
• セキュリティ: OpenAPI仕様から認証/認可を実装
• スケーラビリティ: 成長と保守をサポートする設計パターン

次のステップ

生成後:

1. 生成されたコード構造を確認し、必要に応じてカスタマイズ
2. フレームワーク要件に従って依存関係をインストール
3. 環境変数とデータベース接続を設定
4. テストを実行して生成されたコードを検証
5. 開発サーバーを起動
6. 提供されている例を使用してエンドポイントをテスト

必要に応じて確認する質問

• アプリケーションはデータベース/ORM設定を含めるべきか、またはメモリ内/モックデータだけか?
• コンテナ化用のDocker設定が必要か?
• 認証はJWT、OAuth2、APIキー、または基本認証か?
• 統合テストだけでなく単体テストが必要か?
• 特定のデータベース技術の優先順位があるか?
• APIはページネーション、フィルタリング、ソートの例を含めるべきか?