1.4.3 • Published 4 years ago
@findmio/openapi v1.4.3
使用须知
此仓库为魔改版,主要改动点
- 修改函数名为 请求方式-请求路径
介绍
根据 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.json 的 script 中添加 api: "openapi": "ts-node openapi.config.ts",
生成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 |
1.4.3
4 years ago