0.0.9 • Published 4 years ago
luna-openapi v0.0.9
介绍
根据 OpenApi3 文档生成 request 请求代码。
如果你使用 umi ,你可以使用plugin-openapi 插件。
使用
npm i --save-dev luna-openapi在项目根目录新建 openapi.config.ts
const { generateService } = require('luna-openapi')
generateService({
schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
serversPath: './servers',
genType: 'ts',
})在 package.json 的 script 中添加 api: "openapi": "ts-node openapi.config.ts",
如果没有安装ts-node 可以执行命令: npm install -g ts-node typescript '@types/node'
生成api
npm run openapi参数
| 属性 | 必填 | 备注 | 类型 |
|---|---|---|---|
| requestLibPath | 否 | 自定义请求方法路径 | string |
| requestImportStatement | 否 | 自定义请求方法表达式 | string |
| apiPrefix | 否 | api 的前缀 | string |
| serversPath | 否 | 生成的文件夹的路径(默认src/services) | string |
| schemaPath | 否 | openAPI 3.0 的地址 | string |
| projectName | 否 | 项目名称 | string |
| namespace | 否 | 命名空间名称 | string |
| mockFolder | 否 | mock目录 | string |
| genType | 是 | 代码类型 js or ts | string |