[开源]一款基于Vue和Electron的企业级开源接口文档管理工具

科技一飞开源 2025-04-18 11:22:47

一飞开源,介绍创意、新奇、有趣、实用的开源应用、系统、软件、硬件及技术,一个探索、发现、分享、使用与互动交流的开源技术社区平台。致力于打造活力开源社区,共建开源新生态!

一、开源项目简介

摸鱼一款基于 Vue 和 Electron 的接口文档管理工具二、开源协议

使用MIT开源协议

三、界面展示预览

四、功能概述主要功能

团队协作

登录,注册,修改个人信息,修改密码管理员细粒度权限控制,控制到单个前端路由,单个后端接口接口管理基础权限,管理员、读写权限、只读权限、批量用户导入,用户禁用,用户权限更改自定义权限

接口调试

常见 GET、POST、PUT、DELETE、HEAD、OPTIONS 等请求方式支持 restful 风格接口调试支持查询字符串,body 传参支持 form-data、x-www-form-urlencoded、json、xml、text、二进制等支持自定义请求头支持变量支持优雅的 json 展示,支持多种 MIME 类型返回数据展示前置钩子(pre-request)websocket

左侧导航菜单

支持任意层级嵌套,无接口数量限制支持拖拽支持批量拖拽支持鼠标右键。新增、模板新增、重命名、删除等支持快捷键。eg: F2 修改文件名、Ctrl + 鼠标左键批量选中、Ctrl + 鼠标移入显示详情支持批量删除支持接口复制支持文件夹复制支持导航菜单随 Tab 导航同步展开支持导航菜单排序支持根据 URL 搜索、文档名称搜索支持高级筛选,操作人员、文档日期范围、最近 N 条数据、文档标签支持宽度调整

左侧导航栏快捷操作

新建文件新建文件夹导出文档生成在线链接刷新导航栏数据预览文档导入文档历史记录项目配置回收站自定义快捷栏组成

顶部 tabs 切换

支持拖拽支持右键菜单支持显示修改状态

接口录入

支持修改缓存,防止数据未保存丢失支持按模板新建单个接口,选择模板新增接口支持按模板批量新增多个接口支持自定义变量支持 cookie 自动携带支持 restful 风格路径参数支持查询字符串(?id=3&name=lee)支持丰富的 body 传参类型。form-data、x-www-form-urlencoded、json、xml 等支持录入规则配置,允许用户根据请求方法限制传参类型(eg: 限制 post 请求只支持 json 类型传参)支持任意多个返回参数展示(eg: 成功返回,失败返回)支持自定义请求头支持富文本备注信息填写支持参数模板,常见参数保存为模板方便下次引用支持 json 格式参数导入,导入参数自动带出备注信息支持智能补全,参数录入后,会自动根据历史记录补全参数类型、备注、值、是否必填等信息支持接口标签,用户可自定义接口标签方便管理

录入审计

从新增项目开始,所有操作(接口增删改查、新增人员、拷贝、移动、导入导出等)全部纳入审计丰富的历史纪录筛查功能,直观的历史纪录展示功能完整的操作信息纪录(谁在什么时间操作了什么)历史纪录保存无数量限制删除数据还原接口修改回退任意版本接口任意版本数据对比

快捷键

常见操作快捷键(导出文档、导入文档、生成在线链接)常见行为快捷键(新增接口、保存接口)自定义快捷键

Mock 数据

完整 Mockjs 语法快速 Mock,真实服务端环境下调用,无需任何配置自定义枚举 Mock 值

第三方导入

支持追加导入和覆盖方式导入支持导入到当前项目任意文件夹内项目自身文档导入postman 格式导入swagger/openapi 格式导入yapi 格式导入rap2 格式导入Eolinker 格式导入DOClever 格式导入Curl 格式导入

文档导出

支持 HTML 格式导出,支持全量导出,支持任意数量导出 快乐摸鱼离线文档.html支持 JSON 格式导出,支持全量导出,支持任意数量导出 快乐摸鱼离线数据.json项目内自由导出,支持将当前项目(任意多个文档)导出到任意项目任意位置支持 PDF 格式导出五、技术选型主要技术栈VueElectronEgg.jsElementUIMongoDB六、源码地址

访问一飞开源:https://code.exmay.com/

0 阅读:0

科技一飞开源

简介:感谢大家的关注