@coderwhytop/api-cli

一个强大的 API 代码生成工具，支持从 YAPI 和 APIPost 文档自动生成 TypeScript/JavaScript API 函数。

特性

• 🚀 支持 YAPI 和 APIPost 平台 (YAPI加速迭代中...)
• 📁 按业务模块和 URL 前缀智能分组
• 🔧 自动生成 TypeScript 类型定义(支持TS类型迭代中...)
• 📄 导出结构化的 JSON 数据文件
• ⚡ 支持自定义模板
• 🎯 零配置快速上手

安装

npm install -g @coderwhytop/api-cli

使用方法

快速开始

api-gen

首次运行会引导您创建配置文件。

配置文件示例

创建 api-generator-config.json：

{
  "platform": "apipost",
  "baseUrl": "https://your-api-platform.com/api/export",
  "token": "your-api-token",
  "projectId": "your-project-id",
  "output": "src/api",
  "targetLanguage": "typescript"
}

配置参数

• platform: API 平台类型，支持 "yapi" 或 "apipost"
• baseUrl: API 平台地址
• token: 项目访问令牌
• projectId: 项目 ID（仅 APIPost 需要）
• output: 输出目录（只能是目录路径）
• targetLanguage: 目标语言，支持 "javascript" 或 "typescript"

输出结构

output/
├── function/
│   ├── 后台管理/
│   │   ├── talk.ts          # /talk/* 相关的API
│   │   ├── talk.types.ts    # talk相关的类型
│   │   ├── dict.ts          # /dict/* 相关的API
│   │   └── dict.types.ts    # dict相关的类型
│   └── 用户端/
│       ├── talkUser.ts      # /talkUser/* 相关的API
│       └── talkUser.types.ts
└── json/
    ├── 后台管理/
    │   ├── talk.json        # talk相关的原始API数据
    │   └── dict.json        # dict相关的原始API数据
    └── 用户端/
        └── talkUser.json

生成的代码示例

import request from "@/request"

/**
 * 用户登录
 * @method POST
 * @path /user/login
 */
export interface RequestUserLogin {
  username: string
  password: string
}

export interface ResponseUserLogin {
  code: number
  data: {
    token: string
    userInfo: any
  }
}

export async function user_login_post(params: RequestUserLogin) {
  return request<ResponseUserLogin>({
    url: "/user/login",
    method: "post",
    data: params
  })
}

许可证

MIT

作者

yangboxun