| name | orchestrating-api-implementation |
| description | JSONで定義されたAPI仕様を元にRuby on RailsでAPIと管理画面を実装するスキル。全体のオーケストレーションを行い、各ステップの詳細ガイドラインに従って実装を進めます。 |
概要
このスキルは、JSONで定義されたAPI仕様に基づいて、Ruby on Rails + PostgreSQLでAPIと管理画面を実装します。
このスキルを使用するタイミング
Claudeは以下の状況でこのスキルを使用します:
- ユーザーがJSON形式のAPI仕様を提供し、Rails APIの実装を依頼した場合
- microCMSなどのHeadless CMSの仕様からRails APIを生成する場合
- 既存のJSON仕様ファイル(app.jsonなど)を参照してAPI実装を依頼された場合
- 「APIを実装して」「管理画面を作成して」といったリクエストでJSON仕様が存在する場合
技術スタック
| 項目 | 技術 |
|---|
| 言語 | Ruby 3.4 |
| フレームワーク | Ruby on Rails 8.1 |
| データベース | PostgreSQL 18 |
| ORM | Active Record |
ステップ
各ステップの詳細は steps/ ディレクトリ内のファイルを参照してください。
1. アプリケーション仕様を確認する
詳細: @steps/01_check_specification.md
Claudeは、JSON仕様ファイルを読み込み、モデル構造・フィールド定義・リレーションを把握します。
仕様形式: @references/01_json_specification.md
2. 技術スタックを決定する
詳細: @steps/02_select_tech_stack.md
Claudeは、環境確認と管理画面の方式(ActiveAdmin / Administrate / Hotwire)を決定します。
3. ユースケースを洗い出す
詳細: @steps/03_define_usecases.md
Claudeは、JSON仕様のアクター・ユースケースを確認し、各モデルのCRUD操作、ページネーション、フィルタリング、ソート、リレーション取得方法を定義します。
4. OpenAPI定義を作成する
詳細: @steps/04_define_openapi.md
Claudeは、ユースケースとモデル定義に基づいて、APIの仕様をOpenAPI 3.1形式で定義します。
5. DBスキーマを設計する
詳細: @steps/05_design_db_schema.md
Claudeは、JSON仕様の型をPostgreSQLの型にマッピングし、テーブル設計を行います。
6. SQLとインデックスを定義する
詳細: @steps/06_define_sql_and_indexes.md
Claudeは、ユースケースで実行されるSQLを洗い出し、通常インデックスと全文検索インデックス(GIN + tsvector)を定義します。