API 代码生成工具

从 OpenAPI 规范自动生成 JavaScript API 接口代码。

📁 文件说明

文件	说明	使用频率
generateApiFromOpenAPI.js	主脚本 - 从 OpenAPI 生成 API 代码	⭐⭐⭐ 高频
apiDiff.js	API 对比工具 - 检测 API 变更和破坏性改动	⭐⭐ 中频
test-generate.js	测试脚本 - 验证生成的 API 文件是否正确	⭐ 低频
API_GUIDE.md	使用指南 - 详细的 API 维护工作流文档	📖 文档

🚀 使用方式

# 生成所有 API 接口
pnpm api:generate

# 生成指定模块
pnpm api:generate -- --module=user

📖 详细文档

参见 API_GUIDE.md 了解完整的 API 维护工作流。

🔧 工作原理

1. 扫描 docs/api-specs/ 目录下的 OpenAPI 文档
2. 解析 Markdown 文件中的 YAML 规范
3. 检测 API 变更（新增、修改、删除）
4. 生成符合项目规范的 JavaScript API 代码
5. 保存到 src/api/ 目录

📝 生成代码示例

输入 (OpenAPI YAML):

paths:
  /user/info:
    get:
      summary: 获取用户信息
      parameters:
        - name: user_id
          in: query

输出 (JavaScript):

/**
 * 获取用户信息
 * @param {Object} params
 * @param {string} params.user_id - 用户ID
 */
export const getUserInfoAPI = (params) => {
  return buildApiUrl('user_info', params)
}