# yapi-to-vue3-generate

**Repository Path**: xie_zhi_ying/yapi-to-vue3-generate

## Basic Information

- **Project Name**: yapi-to-vue3-generate
- **Description**: 一个将 YApi 接口自动转换为 Vue3 API 文件的工具。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-15
- **Last Updated**: 2025-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# YApi to Vue3 Generator

一个将 YApi 接口自动转换为 Vue3 API 文件的工具。

## 安装

```bash
npm install -g yapi-to-vue3-generator
```

## 使用方法

### 1. 初始化配置

```bash
yapi-gen init
```

### 2. 生成 API 文件

```bash
# 使用默认配置
yapi-gen generate

# 指定配置文件
yapi-gen generate -c ./my-config.js

# 指定输出目录
yapi-gen generate -o ./src/api

# 使用交互式模式
yapi-gen generate -i
```

## 配置文件

配置文件支持以下路径（按优先级排序）：

- `yapi.config.js`
- `config/yapi.config.js`
- `.yapirc.js`

### 配置示例

```javascript
module.exports = {
  yapiUrl: "http://your-yapi-server.com",
  projects: [
    {
      id: 123,
      token: "your-project-token",
      name: "my-project",
      outputDir: "./src/api", // 输出目录
      // 新增：生成过滤选项
      filters: {
        // 指定要生成的分类（可选，不指定则生成所有）
        categories: [], // 例如: ['用户管理', '商品管理']

        // 指定要生成的接口ID（可选，不指定则生成所有）
        interfaceIds: [], // 例如: [123, 456, 789]

        // 指定要排除的分类（可选）
        excludeCategories: [], // 例如: ['测试分类']

        // 指定要排除的接口ID（可选）
        excludeInterfaceIds: [], // 例如: [999]
      },
    },
  ],
  generateConfig: {
    // 是否使用驼峰命名
    useCamelCase: true,
    // 请求函数导入路径
    requestImportPath: "@/utils/request",
    // 分类映射（可选，用于自定义分类名称）
    categoryMapping: {
      酒店控房计划: "hotelControlRoomPlan",
      仓库管理: "repertoryManagement",
      枚举相关: "findEnuSelect",
    },
    // 是否生成 TypeScript 类型定义
    generateTypes: false,
    // 新增：交互式选择模式
    interactiveMode: true,
  },
};
```


本地使用的node命令如下：
## 使用默认配置文件
node bin/cli.js generate

## 指定配置文件
node bin/cli.js generate -c ./my-config.js

## 交互式模式
node bin/cli.js generate -i

## 初始化配置文件
node bin/cli.js init

## License

MIT