@sofunny/openapi
v1.0.9
Published
根据 [OpenApi3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 request 请求代码。
Downloads
3
Readme
介绍
根据 OpenApi3 文档生成 request 请求代码。
使用
npm i --save-dev @sofunny/openapi
在项目根目录新建 openapi.config.js
const { generateService } = require('@sofunny/openapi')
generateService({
schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
serversPath: './servers',
})
在 package.json
的 script
中添加 api: "openapi": "node openapi.config",
生成api
npm run openapi
参数
| 属性 | 必填 | 备注 | 类型 | | ---- | ---- | ---- | ---- | | requestLibPath | 否 | 自定义请求方法路径 | string | | requestImportStatement | 否 | 自定义请求方法表达式 | string | | apiPrefix | 否 | api 的前缀 | string | | serversPath | 否 | 生成的文件夹的路径 | string | | schemaPath | 否 | openAPI 3.0 的地址 | string | | projectName | 否 | 项目名称 | string | | namespace | 否 | 命名空间名称 | string | | mockFolder | 否 | mock目录 | string | | interfacePrefix | 否 | interface 是否加上模块前缀 | boolean