@open-autofe/generator-swagger

根据swagger文档自动生成ts接口文件

安装

yarn add @open-autofe/generator-swagger
#or 
npm i @open-autofe/generator-swagger

使用

# 生成配置文件
oas init

配置文件

支持swagger v3 和 v2

const path = require("path");

module.exports = {
  // 入口
  entry: {
    "sys": "http://www.xx.com/v3/api-docs",
    "test": path.resolve("src", "test", "v2.json"),
  },
  // 输出目录 相对路径 相对于项目根目录
  output: path.resolve("src", "api"),
  // 排除列表
  exclude: [
    {
      type: "entity",
      test: /^PageList«/
    },
    {
      type: "entity",
      test: /^ResponseResult«/
    },
    {
      type: "path",
      test: /^\/other-v100001/
    },
    {
      type: "path",
      test: /^\/sys-v100001/
    }
  ],
  // 版本
  version: "v1.0.0",
}

# 根据配置文件规则生成接口文档
oas generator