0.2.9 • Published 1 year ago

hlsa-swagger-to-interface v0.2.9

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

介绍

从umi-openapi 里克隆出来的 地址:https://www.npmjs.com/package/@umijs/openapi
更改了template里的controller模板 让他支持vben格式

使用

npm i --save-dev hlsa-swagger-to-interface

在项目根目录新建 openapi.config.ts

const { generateService } = require('hlsa-swagger-to-interface')

generateService({
  schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
  serversPath: './servers',
})

package.jsonscript 中添加 api: "openapi": "ts-node openapi.config.ts",

生成api

npm run openapi

参数

属性必填备注类型默认值
requestLibPath自定义请求方法路径string-
requestImportStatement自定义请求方法表达式string-
apiPrefixapi 的前缀string-
serversPath生成的文件夹的路径string-
schemaPathSwagger 2.0 或 OpenAPI 3.0 的地址string-
projectName项目名称string-
namespace命名空间名称stringAPI
mockFoldermock目录string-
enumStyle枚举样式string-literal | enumstring-literal
nullable使用null代替可选booleanfalse
dataFieldsresponse中数据字段string[]-