swagger2.0 接口自动化转化方案

转化swagger 2.0 json配置 为axios风格api接口 安装

npm install swagger-to-api-v3
or
pnpm add swagger-to-api-v3

使用样例

在项目目录下新建 ：parseapi.js

const GenerateSwaggerApi = require("swagger-to-api-v3")
// 请求 url 生成请求api
const createApi = new GenerateSwaggerApi({
  url: "https://petstore.swagger.io/v2/swagger.json",
})
createApi.generate_api()

|参数 | 类型 | 默认值 | 说明 | | --- | --- | --- | --- | | readJsonMode | String | url | json 读取模式 网络地址 | 文件路径 "url"|"file" 默认url 模式 | | url | String | | readJsonMode 为 url 时，读取网络swagger配置json，本地文件可以利用Live Server插件启动本地文件服务 | | path | String | | readJsonMode 为 file 时，读取本地swagger配置json | | basedir | String | swagger-api/ | 可选： 存放api的目录 默认项目目录下 swagger-api/文件夹 | | requirePath | String | import { request } from "@/utils/service"\n\n | 可选： 引用request请求函数的路径 | | generateFuncNameMode | String | simple | 可选： 函数名及接口模型生成模式（数据源）1.简单模式 2.url 全链解析模式 3.唯一ID operationId模式 默认 simple， "simple"| "url" | "operationId" | | ignorePrefix | Array | ["api", "front"] | 可选： generateFuncNameMode 为url时，函数名处理掉公共前缀(函数名生成规则：接口path拼接 /api/front/appController/getPag )，处理后appControllerGetPag | | replaceRule | Map | new Map() | 可选： 自定义替换规则，例如：new Map([["object", "any"]]), 将object替换为any | | publicHeader | Object | {} | 可选： 自定义公共请求头，例如：Record<string, string>, 将请求体内会生成相关请求头信息 | | useExample | Boolean | false | 可选： 使用 swagger 的example数据辅助生成类型 例如：某Long类型 标识为{ example: String}，就将其处理为string类型，此处理优先级较高 | | urlPrefix | String | "" | 可选：给请求的实际api添加 前缀 |

在package.json内添加scripts命令

  "scripts": {
    "create:api": "node parseapi.js"
  }

键入

npm run create:api
or
pnpm create:api