前言

之所以开发这个综合工具平台,其初衷是解决我们前端转 Vue3+TypeScript+Vite 的框架后,如何快速生成 api 接口调用文件的问题

建设背景

  1. 接手前端项目是痛苦的,目前我的认识是前端项目规范性差一些,所以大家每个人一个写法
  2. 为了解决这个问题,我们开发了Element-Admin-Web的管理后台框架,就是解决大家规范性的问题,当然其他 uniapp 的框架也在开发中
  3. 前端要向 Vue3+TypeScript+Vite 转型,我们选择了 Arco Design 框架
  4. 后端通过 Swagger 进行接口管理,那么可以根据 Swagger 接口定义,自动为前端生成 api 的 ts 文件

目前综合工具平台open in new window刚刚实现,Arco Design 给出了很规范的接口定义,我们遵循该接口定义,生成 Ts 文件

如何使用

使用起来很简单,请打开综合工具平台open in new window,在 input 框中输入 Swagger 接口的地址,一键生成接口调用文件,放在 Arco Design 框架的 api 目录下

  1. 目前是一个模块一个接口 ts 文件
  2. 自动生成接口的 Request 模型,其中 Request 中的属性 目前都是可选的,即 属性名?:类型
  3. 响应 Response 的 result 是 any 类型,有道理,因为很多情况下我们要对 result 进行加工

刚刚开发出该工具,请大家感觉和试用,如有问题,请 call TerryQi

代码位置

  • 后端代码
https://gitee.com/qrqy/tools-web-server.git
  • 前端代码
https://gitee.com/qrqy/tools-web.git
Last Updated:
Contributors: TerryQi