一款基于 Vue 和 Electron 的接口文档管理工具

100 阅读4分钟

前言

前后端分离开发模式下,接口文档的规范性和可维护性直接影响团队协作效率。传统文档管理工具存在权限控制粗糙、调试功能割裂、跨平台适配困难等问题。

今天推荐一款基于Vue与Electron的开源接口文档管理工具,它以"全功能客户端+轻量化服务端"为核心设计理念,通过模块化架构实现接口管理、调试、Mock等功能的深度整合。

项目介绍

该工具定位为全栈式接口文档管理平台,支持从接口设计到调试的全生命周期管理。

大家可通过客户端直接访问体验服务器,无需自行搭建后端即可使用完整功能。对于企业级用户,项目提供详细的部署文档,支持私有化部署至Node.js环境(需14.x及以上版本),并兼容Mac、Linux、Windows三大操作系统。

项目功能

1、团队协作体系

用户管理:支持注册、登录、密码修改及批量导入功能,管理员可对单个路由或接口进行细粒度权限控制(读写/只读/禁用)。

审计追踪:完整记录接口增删改查、人员变动等操作,支持历史版本对比与数据还原。

2、接口调试中心

覆盖GET/POST/PUT等6种HTTP方法,支持Restful路径参数、查询字符串及多种Body格式(JSON/XML/二进制)。

提供前置钩子、WebSocket调试、变量管理等功能,响应数据可按MIME类型智能展示。

3、文档管理模块

左侧导航栏支持无限层级嵌套,通过拖拽、右键菜单实现批量操作,快捷键(如Ctrl+左键批量选中)提升效率。

顶部Tabs支持拖拽排序,接口录入时提供模板导入、参数智能补全及富文本备注功能。

4、Mock与数据导出

内置Mockjs语法引擎,支持自定义枚举值生成测试数据。

导出格式涵盖HTML/JSON/PDF,支持全量或选择性导出,并可追加至其他项目文件夹。

项目特点

跨平台兼容性:Electron框架实现桌面端统一体验,脱离浏览器限制。

权限精细化:从路由级到接口级的权限控制,满足企业安全需求。

调试一体化:文档编辑与接口测试无缝切换,减少上下文切换成本。

导入生态丰富:支持Postman、Swagger等7种主流工具数据迁移。

项目技术

前端架构:Vue 3 + ElementUI构建响应式界面,通过Electron封装为桌面应用。

后端服务:Egg.js提供RESTful API,MongoDB存储文档与用户数据。

开发流程:依赖Yarn管理包,通过npm run electron:build一键打包多平台安装包。

项目体验

体验地址: online.jobtool.cn

项目效果

用户反馈"Mock数据生成"与"历史版本对比"功能显著优化了测试流程。

系统首页

图片

项目列表

图片系统展示图片

项目部署

部署步骤

1、克隆代码库(国内用户推荐Gitee镜像)

2、执行npm install安装依赖

3、运行npm run electron:build生成安装包

项目源码

GitHub:github.com/trueleaf/mo…

Gitee:gitee.com/shuzhikai/a…

总结

这款工具通过技术栈的巧妙组合,解决了传统接口文档管理的三大痛点:权限控制不足、调试体验割裂、跨平台适配困难。尤其适合中大型团队进行私有化部署。未来计划集成AI参数推荐与自动化测试功能,进一步降低开发门槛。

关键词

#Vue#Electron#接口文档#权限控制#Mock数据#跨平台#团队协作#Egg.js、#MongoDB#开源工具#开源项目

最后

如果你觉得这篇文章对你有帮助,不妨点个赞支持一下!你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助,欢迎随时留言。

也可以加入微信公众号 [DotNet技术匠] 社区,与其他热爱技术的同行一起交流心得,共同成长!

优秀是一种习惯,欢迎大家留言学习!