跳到主要内容

使用教程

介绍​

GitHub Repo starsnpm (scoped)GitHub tag (latest SemVer pre-release)

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

如果你使用 umi,你可以使用@umijs/plugin-openapi 插件。 本项目参考了：https://github.com/chenshuai2144/openapi2typescript 在此基础上进行了一些修改。 新增功能如下：

状态说明
✅支持用户自定义接口模版
✅系统内置多种请求库模版，如：axios、umi-request
✅接口文件名以xxxController.ts命名

使用​

pnpm i --save-dev @yunfeidog/openapi2typescript

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

import {generateService} from "@yunfeidog/openapi2typescript";

generateService({
    schemaPath: `${__dirname}/test/openapi.json`,
    serversPath: './test/gen/umi',
    requestLibrary: 'umi',
    customServicePath: 'test/custom-service-template'
});


供公司使用:

import {generateService} from "@yunfeidog/openapi2typescript";

let service = ['auth', 'baas', 'docshare', 'did', 'generator', 'governance']
for (let i = 0; i < service.length; i++) {
    generateService({
        schemaPath: `http://192.168.2.141:18001/${service[i]}/v3/api-docs`,
        serversPath: `./casll/${service[i]}`,
        requestLibrary: 'axios',
        requestImportStatement: 'import { request } from "@/utils/http"',
    });
}

在 package.json 的 script 中添加 api: "openapi": "ts-node openapi.config.ts",

生成api

pnpm run openapi

参数​

属性必填备注类型默认值
requestLibPath否自定义请求方法路径string-
requestLibrary是默认支持的请求库'umi' 、'axios'、 'fetch'、 'request'、 'custom'umi
customServicePath是如果requestLibrary为custom，那么需要传入自定义的Controller位置string
requestOptionsType否自定义请求方法 options 参数类型string{[key: string]: any}
requestImportStatement否自定义请求方法表达式string-
apiPrefix否api 的前缀string-
serversPath否生成的文件夹的路径string-
schemaPath否Swagger 2.0 或 OpenAPI 3.0 的地址string-
projectName否项目名称string-
namespace否命名空间名称stringAPI
mockFolder否mock目录string-
enumStyle否枚举样式string-literal | enumstring-literal
nullable否使用null代替可选booleanfalse
dataFields否response中数据字段string[]-
isCamelCase否小驼峰命名文件和请求函数booleantrue
hook否自定义 hookCustom Hook-

Custom Hook​

属性类型说明
afterOpenApiDataInited(openAPIData: OpenAPIObject) => OpenAPIObject -
customFunctionName(data: APIDataType) => string 自定义请求方法函数名称
customTypeName(data: APIDataType) => string 自定义类型名称
customClassName(tagName: string) => string 自定义类名
customType(<br>schemaObject: SchemaObject | undefined,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject | undefined, namespace: string) => string,<br>) => string自定义获取类型 <br> 返回非字符串将使用默认方法获取type
customFileNames(<br>operationObject: OperationObject,<br>apiPath: string,<br>_apiMethod: string,<br>) => string[]自定义生成文件名，可返回多个，表示生成多个文件. <br> 返回为空，则使用默认的获取方法获取
0%