generate-api-client
Orval APIクライアント生成スキル(OpenAPI仕様書から型安全なAPIクライアントを自動生成)
When & Why to Use This Skill
This Claude skill automates the generation of type-safe API clients from OpenAPI specifications using Orval. By streamlining the synchronization between backend API definitions and frontend implementation, it eliminates manual boilerplate code, ensures data consistency, and enhances developer productivity through automated TypeScript type-checking.
Use Cases
- Automatically updating frontend API client methods and TypeScript interfaces whenever the backend OpenAPI schema (api-docs.yaml) changes.
- Reducing integration errors by ensuring that the frontend data models strictly match the backend response structures through automated type generation.
- Accelerating the development of new features by instantly providing ready-to-use, type-safe fetch functions for newly defined API endpoints.
| name | generate-api-client |
|---|---|
| description | Orval APIクライアント生成スキル(OpenAPI仕様書から型安全なAPIクライアントを自動生成) |
Generate API Client Skill - Orval APIクライアント生成スキル
役割
OpenAPI仕様書(api-docs.yaml)から型安全なAPIクライアントを自動生成するスキルです。
実行フロー
Phase 1: 仕様書確認
# OpenAPI仕様書の存在確認
ls backend/src/main/resources/static/api-docs.yaml
Phase 2: Orval実行
cd frontend
# Orvalで型安全なAPIクライアント生成
pnpm run generate:api
Phase 3: 生成確認
# 生成されたファイル確認
ls frontend/src/lib/api/generated/
Phase 4: 型チェック
# TypeScript型チェック
npx tsc --noEmit
Phase 5: 完了報告
## Generate API Client 完了報告
### 生成結果
- ✅ APIクライアント生成完了
- ✅ 型定義生成完了
- ✅ TypeScript型チェック成功
### 生成ファイル
- frontend/src/lib/api/generated/api.ts
- frontend/src/lib/api/generated/model.ts
### 次のステップ
生成されたAPIクライアントをimportして使用できます。