OrvalAPI客户端生成技能Skill generate-api-client

该技能用于从OpenAPI规范文档(如api-docs.yaml)自动生成类型安全的API客户端代码。它通过Orval工具链执行,确保前端应用能够以强类型、可维护的方式调用后端API,提升开发效率和代码质量。关键词:OpenAPI,API客户端,类型安全,自动生成,前端开发,TypeScript,代码生成。

前端开发 0 次安装 0 次浏览 更新于 3/3/2026

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客户端。