基于Vue和Electron开源接口文档管理工具

传送门

GitHub地址

Gitee地址

完整文档

前言

【快乐摸鱼】是一款基于Vue和Electron的开源接口管理工具。
最初构建这个项目的时候是为了学习Node.js和解决团队前后端协调问题。社区中有 YApi 、Rap2、Doclever、 Nei、Swagger、Apidoc等开源解决方案，同时也存在 Postman、Eolinker、ApiPost等商业解决方案。

在这之前团队尝试了YApi和Rap2等社区方案，他们能够满足一些基本的需求，但是在深入使用以后，还是出现了一些影响效率的问题。当时使用这两个工具最大的问题就是接口无法支持多级嵌套，某些项目接口多了以后会导致检索效率大大降低。于是尝试从头开始写一款接口管理工具。

团队协作

非常核心的一个功能，在前后端分离情况下，一套简洁的团队管理策略会大大提高分工效率。我们将权限分为 只读、读写、管理员三类。

• 只读：只允许用户查看文档(一般可以给前端开发人员赋予这个角色)
• 读写：允许对文档进行增删改查等(一般可以给后端开发人员赋予这个角色)
• 管理员：除了读写以外还可以增加或者删除用户

上面的三种角色可以满足大部分日常使用需求。在一些特殊情况下你可能需要更加细粒度的权限控制，比如：拥有读写权限的用户你只希望他能编辑文档，但不希望他能导出全部文档。我们提供了自定义角色功能，可以精确到每一个接口和路由(一般情况下用不到)。