根据 swagger 文档自动生成 ts 类型

使用方法

全局安装 npm

# npm
npm install yc-apigen -g
# yarn
yarn global add yc-apigen

在项目下根路径自动生成 api-gen.json 文件

ycag config

{
  "controllerNameMap": {
    "Foo控制器": "FooController",
    "Bar控制器": "BarController"
  },
  // swagger 地址，可以为本地文件也可以为 url
  "swaggerApiPath": "./api-docs.json"
  "methodName": {
    "post": "post",
    "get": "get",
    "put": "put",
    "remove": "remove",
  },
  include: ["VO", "Controller"],
  outputPath: './src/yc-apigen',
  requestFilePath: './src/request/axios.ts',
  // 是否导入被标记为废弃的方法
  importDeprecations: boolean,
  // 忽略类型的 VO
  markAsAnyVOList: ['Resource']
}

配置好文件以后，执行命令

ycag gen

就会生成如下的目录结构

- src
  - request
    - controller
      - FooController.ts
      - BarController.ts
    - vo
      - SomeVO.ts
      ...
    // 服务端泛型
    - server-generic.ts

注意事项

需要有一个请求文件，导出四个方法：

put, post, update, remove

接受参数分别为 path, params, body

如

post(path, queryParams, body)