# 根据Api文档自动生成函数

**Repository Path**: lucky663/swaggerFunction

## Basic Information

- **Project Name**: 根据Api文档自动生成函数
- **Description**: 后端使用Swagger进行api文档搭建都可使用该脚本创建对应请求方法
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-18
- **Last Updated**: 2025-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Swagger, 前端, JavaScript

## README

# 根据 Swagger 文档自动生成 Api 方法

### 配置 Config.js

1. 先在 config.js 中配置,配置项如下

   | 属性名                    | 类型          | 描述                       | 示例                              |
   | ------------------------- | ------------- | -------------------------- | --------------------------------- |
   | maxParams                 | number        | 函数参数最大个数           | 5                                 |
   | docComments               | boolean       | 是否生成文档注释           | true                              |
   | functionTitle             | boolean       | 函数标题                   | true                              |
   | apiContentPath            | string        | apifox中导出的接口json文件 | --                                |
   | apiDocUrls                | Array<string> | 文档请求地址获得Json       | http://xx/swagger/xx/swagger.json |
   | requestBodyVar            | string        | 生成后请求体参数变量名     | _requestBody                      |
   | queryVar                  | string        | 生成后查询参数变量名       | _querys                           |
   | formDataVar               | string        | 生成后formData变量名       | _formData                         |
   | notCreateApi              | Array<string> | 不需要生成的Api            | ['/api/xxx']                      |
   | notCreateDir              | Array<string> | 不需要生成的文件           | ['xxx']                           |
   | templatePath              | string        | 模板文件地址               | ./template.js                     |
   | fileSuffix                | string        | 生成文件后缀               | .js                               |
   | output                    | string        | 输出目录                   | "./api"                           |
   | unifiedprefix             | string        | 统一前缀                   | /api                              |
   | maxConcurrent             | number        | 请求最大并发数             | 4                                 |
   | placeholder               | object        | 模板中的占位符             | --                                |
   | placeholder.methodName    | string        | 函数名                     | $METHOD_NAME                      |
   | placeholder.url           | string        | 请求地址                   | $URL                              |
   | placeholder.method        | string        | 请求方法                   | $METHOD                           |
   | placeholder.paramsList    | string        | 参数列表                   | $ARGS                             |
   | placeholder.contentType   | string        | *传输数据类型*             | $CONTENT_TYPE                     |
   | placeholder.body          | string        | 请求体                     | $BODY                             |
   | placeholder.beforeContent | string        | 函数体开始                 | $BEFORE_CONTENT                   |
   | console                   | object        | 控制台配置项               | --                                |
   | console.dirFileOutput     | boolean       | 文件完成打印信息           | true                              |
   | console.apiOutput         | boolean       | api 完成打印信息           | true                              |

   > 注: **apiContentPath** 和 **apiDocUrls** 选其一 **apiDocUrls优先级高**  其他配置可选	

2. 配置完成后双击运行 **run.bat** 即可

### 不配置 Config.js

使用 **node ./index.js** 运行 或 **npm run api**(详情见package.json文件中配置) 即可 可以添加对应参数 如

**node ./index.js o=./api args=6 t=./templatePath.js** ...

参数支持以下参数

| 参数名 | 对应字段                                                 |
| ------ | -------------------------------------------------------- |
| o      | output                                                   |
| args   | maxParams                                                |
| api    | apiContentPath                                           |
| s      | fileSuffix                                               |
| t      | templatePath                                             |
| d      | docComments                                              |
| f      | functionTitle                                            |
| up     | unifiedPrefix                                            |
| config | 自定义config.js 路径 config.js导出规范需使用CommonJS规范 |