1.0.3 • Published 14 days ago
swagger-to-api-v3 v1.0.3
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({
// json 读取模式 网络地址 | 文件路径 "url"|"file" 默认url 模式
readJsonMode: "url",
// readJsonMode 为 url 时,读取网络swagger配置json,本地文件可以利用Live Server插件启动本地文件服务
url: "https://petstore.swagger.io/v2/swagger.json",
// readJsonMode 为 file 时,读取本地swagger配置json
path: "./swagger.json",
// 可选: 存放api的目录 默认项目目录下 swagger-api/文件夹
basedir: "swagger-api/",
// 可选: 引用request请求函数的路径
requirePath: 'import { request } from "@/utils/service"\n\n',
// 可选: 函数名及接口模型生成模式(数据源)1.简单模式 2.url 全链解析模式 3.唯一ID operationId模式 默认 simple, "simple"| "url" | "operationId"
generateFuncNameMode: "simple",
// 可选: generateFuncNameMode 为url时,函数名处理掉公共前缀(函数名生成规则:接口path拼接 /api/front/appController/getPag ),处理后appControllerGetPag
ignorePrefix: ["api", "front"],
// 可选: 自定义替换规则,例如:new Map([["object", "any"]]), 将object替换为any
replaceRule: new Map(),
// 可选: 使用 swagger 的example数据辅助生成类型 例如:某Long类型 标识为{ example: String},就将其处理为string类型,此处理优先级较高
useExample: false
})
createApi.generate_api()
在package.json内添加scripts命令
"scripts": {
"create:api": "node parseapi.js"
}
键入
npm run create:api
or
pnpm create:api
1.0.3
14 days ago
1.0.2
24 days ago
1.0.11
2 months ago
1.0.1
2 months ago
0.0.22
4 months ago
0.0.20
5 months ago
0.0.21
5 months ago
0.0.19
5 months ago
0.0.18
5 months ago
0.0.10
7 months ago
0.0.11
7 months ago
0.0.12
7 months ago
0.0.13
7 months ago
0.0.15
7 months ago
0.0.16
7 months ago
0.0.17
6 months ago
0.0.9
7 months ago
0.0.8
7 months ago
0.0.5
7 months ago
0.0.4
7 months ago
0.0.7
7 months ago
0.0.6
7 months ago
0.0.3
7 months ago
0.0.2
7 months ago
0.0.1
7 months ago