TeamBlog——规范、高效的项目管理知识库
艺萨科技
千日千月
艺萨科技
千日千月
  • Guide
  • 数据库规范
    • 基础规范
    • 通用模型
  • Vue前端框架
    • Guide
    • 通用说明
    • Element-admin-web
    • Arco-Design-web
  • Java服务端框架
    • Guide
    • 通用说明
    • JPA的封装
    • jDaoMySQL的使用
    • jCoder代码生成
    • 应用配置文件
  • PHP服务端框架
    • Guide
    • schedule定时任务
    • 数据库表、字段的命名原则
    • 接口文档自动生成
    • 队列
    • 日志管理
    • 接口加密
    • 文件的处理
    • RBAC的权限控制(待补充)
    • 一些工具
    • 一些写法
    • env说明
    • 公共的方法
  • 通用能力
    • Guide
    • Web文件预览
    • 统计平台
    • KeyCloak
    • 综合工具平台
    • 内网穿透
    • IM能力
    • 安全扫描

前言

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

建设背景

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

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

如何使用

使用起来很简单,请打开综合工具平台,在 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:: 3/29/23, 11:02 PM
Contributors: TerryQi
Prev
KeyCloak
Next
内网穿透