@vtx/swagger-to-javascript

根据 Swagger 的接口定义生成 JavaScript 请求函数代码，通过配置文件执行指令生成服务代码。

安装

yarn add @vtx/swagger-to-javascript -D

使用

在 src 根目录下新建 stt.config.js 文件，或者执行 stt init 会在执行目录下初始化一个 stt.config.js 文件。

package.json 添加执行脚本

{
    "scripts": {
        "api": "stt"
    }
}

配置项

stt.config.js

module.exports = {
    // swagger服务地址
    serverUrl: 'http://120.27.248.90:15001/v2/api-docs?group=济南-网络情报',
    // 请求函数文件路径
    requestFunctionFilePath: 'src/utils/request.js',
    // 输出文件路径
    outputFilePath: 'src/api/index.js',
    // 操作信息
    extraHeader: true,
    // 项目列表
    projects: [{ tag: '企业', outputFilePath: 'src/api/company.js', gateway: 'cp' }],
};

serverUrl

• Type: String
• Default: ''
• required: 必填项

swagger 服务地址

requestFunctionFilePath

• Type: String
• Default: ''
• required: 必填项

请求函数文件路径

outputFilePath

• Type: String
• Default: ''
• required: 选填

输出文件路径，如果同时配置了 projects 则该属性无效

extraHeader

• Type: Boolean
• Default: false
• required: 选填

是否添加操作信息

projects

• Type: ProjectsItem[]
• Default: []
• required: 选填

若没配置 projects，则必须配置 outputFilePath。

ProjectsItem

tag

• Type: String
• Default: ''
• required: 必填

swagger 服务标签

outputFilePath

• Type: String
• Default: ''
• required: 必填

文件输出路径

gateway

• Type: 'cp' | 'np'
• Default: ''
• required: 选填

gateway，接口是否验证