1.4.3 • Published 2 years ago

@findmio/openapi v1.4.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

使用须知

此仓库为魔改版,主要改动点

  • 修改函数名为 请求方式-请求路径

介绍

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

根据 OpenApi3 文档生成 request 请求代码。

如果你使用 umi ,你可以使用@umijs/plugin-openapi 插件。

使用

npm i --save-dev @umijs/openapi

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

const { generateService } = require('@umijs/openapi')

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
schemaPathopenAPI 3.0 的地址string
projectName项目名称string
namespace命名空间名称string
mockFoldermock目录string