backend-type-bridger について
ローカルのOpenAPIファイルからTypeScriptのAPI型を生成し、Firebaseのスキーマ情報も取得できる開発スキルです。フィールド名を推測せず、正確なバックエンドのデータ形状を必要とするフロントエンド開発向けです。
主な機能
- 01OpenAPIからTypeScript型を生成
- 02プロジェクト内のOpenAPIファイルを参照
- 03Firebase Firestoreスキーマの取得
- 04FastAPI型同期への対応
活用シーン
- 01ローカルAPI仕様からフロントエンド型を作成
- 02API呼び出し実装時のデータ形状確認
- 03フロントエンド開発向けFirebaseスキーマ取得
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ heyeddi-com/ heyeddi-skills --skill backend-type-bridgerインストール後、Claude Code で/backend-type-bridgerを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
manifest.jsoncontext/ANTI_PATTERNS.mdEXAMPLES.mdPROSE_ANTI_SLOP.mdVOCABULARY.mdscripts/_skill_cli.pyfetch_firestore_schema.pysync_openapi.py詳細
バックエンドの型を橋渡し
使用する場面
- フロントエンドエージェントが正確な API ペイロードの形を必要としている場合
- ローカルの
openapi.json(またはプロジェクトルート配下にある別の OpenAPI ファイル)がある場合 - Firebase プロジェクトに Firestore のルールまたはスキーマファイルがある場合
手順
-
ローカルの OpenAPI ファイルを用意します。
openapi.json(プロジェクトルート)に配置してください。スキャフォールドされたファイルを優先します。API が稼働中で、ファイルがないか古くなっている場合は、まずディスクにエクスポートします(このスキルに URL を渡してはいけません)。curl -fsS http://127.0.0.1:8090/openapi.json -o openapi.json -
FastAPI の型:
python scripts/sync_openapi.py --project-root <root>を実行します。ローカルのopenapi.jsonのみからsrc/types/api.tsを生成します(--openapi path/rel.jsonは任意です)。 -
Firebase:
python scripts/fetch_firestore_schema.py --project-root <root>を実行します。 -
生成された型をコンポーザブルでインポートします。フィールド名を推測してはいけません。OpenAPI で
$refが多用されている場合は、生成されたインターフェースを調整してください。
コメント
Markdown 対応