generate-api-client

Orval APIクライアント生成スキル(OpenAPI仕様書から型安全なAPIクライアントを自動生成)

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 11, 2025

When & Why to Use This Skill

The Generate API Client skill automates the creation of type-safe API clients from OpenAPI specifications using Orval. It streamlines the development process by ensuring seamless frontend-backend synchronization, reducing manual boilerplate code, and maintaining strict TypeScript type safety to prevent integration errors.

Use Cases

  • Automated Client Updates: Quickly regenerate frontend API clients and TypeScript models whenever the backend OpenAPI documentation (api-docs.yaml) is updated, ensuring the frontend is always in sync with the latest API changes.
  • Type-Safe Data Fetching: Automatically generate TypeScript interfaces for request bodies and response data, providing full IDE autocompletion and compile-time error checking for all network requests.
  • Development Workflow Optimization: Integrate API generation into the CI/CD or local development loop, including automatic file verification and TypeScript validation to maintain high code quality and reliability.
namegenerate-api-client
descriptionOrval 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して使用できます。