1.1.0 • Published 5 months ago

openapi3-generator-ts v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

介绍

GitHub Repo stars npm (scoped) GitHub tag (latest SemVer pre-release)

根据 OpenApi3 文档生成 request 请求代码。 增加接口的过滤功能。

使用

npm i --save-dev openapi3-generator-ts

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

const { generateService } = require('openapi3-ts-generator')

generateService({
  schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
  servicesPath: './services',
  beforeData(openAPI) {
    // todo 修改参数
    return openAPI;  
  },
})

package.jsonscript 中添加 openapi:

"openapi": "node openapi.config.ts",

生成api

npm run openapi

参数

属性必填备注类型默认值
requestLibPath自定义请求方法路径string-
requestImportStatement自定义请求方法表达式string-
apiPrefixapi 的前缀string-
servicesPath生成的文件夹的路径string-
schemaPathopenAPI 3.0 的地址string-
projectName项目名称string-
namespace类型命名空间名称stringAPITypes
mockPathmock目录string-
enumStyle枚举样式string-literal | enumstring-literal