1.0.6 • Published 11 months ago

swagger-to-api-v3 v1.0.6

Weekly downloads
-
License
ISC
Repository
-
Last release
11 months ago

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

在package.json内添加scripts命令

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

键入

npm run create:api
or
pnpm create:api
1.0.6

11 months ago

1.0.5

11 months ago

1.0.4

11 months ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.11

1 year ago

1.0.1

1 year ago

0.0.22

1 year ago

0.0.20

1 year ago

0.0.21

1 year ago

0.0.19

1 year ago

0.0.18

1 year ago

0.0.10

2 years ago

0.0.11

2 years ago

0.0.12

2 years ago

0.0.13

2 years ago

0.0.15

2 years ago

0.0.16

2 years ago

0.0.17

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago