介绍

根据 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

命令行调用

npm run gen-api

参数

属性	必填	备注	类型	默认值
requestLibPath	否	自定义请求方法路径	string	-
requestImportStatement	否	自定义请求方法表达式	string	-
apiPrefix	否	api 的前缀	string	-
serversPath	否	生成的文件夹的路径	string	-
clear	否	是否删除生成目录下的文件	boolean	false
tags	否	指定需要生成的 tags	string[]	[]
schemaPath	否	Swagger 2.0 或 OpenAPI 3.0 的地址	string	-
projectName	否	项目名称	string	-
namespace	否	命名空间名称	string	API
mockFolder	否	mock 目录	string	-
enumStyle	否	枚举样式	string-literal | enum	string-literal
nullable	否	使用 null 代替可选	boolean	false
dataFields	否	response 中数据字段	string[]	-