@liangskyli/openapi-gen-ts v2.0.1

openapi to typescript 代码生成工具

通过openapi提供ts类型和接口请求代码自动生成，避免重复性工作，提高开发效率。

• 基于openapi v3 生成 ts数据类型和请求库接口代码。
• ts接口类型文件生成
• 通用请求库接口调用文件生成
• 如果需要支持swagger2格式
  • 可以设置isSwagger2为true,并配置swaggerPath。
  • swagger2格式的支持情况依赖swagger2openapi转换openapi V3文件的支持情况
  • 建议非必要不要使用swagger2格式，使用openapi v3格式提供更全面的功能逻辑。

安装:

yarn add @liangskyli/openapi-gen-ts --dev

如果项目没有安装prettier，需要安装prettier(^2.0.0 || ^3.0.0)

yarn add prettier --dev

生成方式:

1、CLI 命令方式（推荐）

• 默认配置文件在运行目录下request.config.ts文件

yarn openapi-gen-ts

• 配置文件别名request.config2.ts

yarn openapi-gen-ts -c ./request.config2.ts

命令参数

命令参数 configFile ts数据生成配置文件参数属性

• 类型：IGenTsDataOpts | IGenTsDataOpts[]

IGenTsDataOpts 参数属性

requestFile属性

• requestFile.path 说明

  • 不设置，默认使用axios,可以自己封装后引入路径使用。
  • ajax请求库路径不做处理，按生成的文件的相对路径或使用绝对路径。
  • 路径下的文件要求默认导出方法,为IAPIRequest类型。

    type IAPIRequest = (param: {
      url?: string;
      method?: OpenapiMethod | Uppercase<OpenapiMethod> | string;
      params?: any;
      path?: any;
      data?: any;
      [k: string]: any;
    }) => Promise<any>;

  • 自定义ajax接口例子：

    import axios from 'axios';
    import type { IAPIRequest } from '@liangskyli/openapi-gen-ts';
    
    const request: IAPIRequest = (config) => {
      // 这里可以封装公共逻辑
      return axios(config).then((res) => res.data);
    };
    
    export default request;
    // 请求库方法入参类型定义名称（非默认导出）,requestParamsType设置导出名
    export { AxiosRequestConfig };

  • 生成的schema-api/request-api.ts文件,可直接用于项目请求接口，无需手动编写代码。

• configFile ts数据生成配置文件示例

  • 配置文件支持使用defineConfig定义ts类型

import { defineConfig } from '@liangskyli/openapi-gen-ts';

export default defineConfig({
  genTsDir: './',
  openapiPath: './openapi/openapiv3-example.json',
});

• openapi v3 YAML or JSON 格式的文件示例，openapi 需要自己根据业务逻辑生成。
• openapi v3 method 支持说明
  • 支持任意openapi接口类型(如："get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace")
  • 支持相同url,对应多个method请求
  • 支持responses 200或default的第一个响应数据（优先200）
  • 支持任意媒体类型(MediaType)的响应数据
  • 支持任意媒体类型(MediaType)的Query请求数据
  • 支持任意媒体类型(MediaType)的Body请求数据,多个媒体类型合并处理
• 生成ts文件结构指引 文档
• 接口API使用指引 文档

2、方法调用方式

genTsData函数参数

• 和命令参数configFile属性一致，见上面说明（命令参数 configFile ts数据生成配置文件参数属性）。
• 使用例子

import genTsData from '@liangskyli/openapi-gen-ts';
genTsData({
  genTsDir: './',
  openapiPath: './openapi/openapiv3-example.json',
}).then();