简介

今天给大家介绍的是一款开源的接口文档管理工具，目的是为了提高前后端联调效率。同类的产品有很多，大部分都非常的优秀，但每款产品或多或少都缺少一些完整的功能，我们学习和使用了常见的几款接口文档管理工具，在此基础开发出一款更为高效的接口工具。

下面这张图展示了一个接口管理工具所具备的主要功能模块。更为详细的内容可以参考思维导图。

团队&权限管理

基础的角色功能能够满足大部分的业务场景，我们也提供更加细粒度的权限控制功能，你甚至可以控制到每一个接口 权限参考。

接口录入

接口录入是整个工具中非常核心的功能，我们浏览了常见开源产品中的大量issue，解决了许多其他产品没有解决的问题。

导航栏任意层级嵌套

丰富的搜索和过滤

• 接口名称
• 接口url
• 创建人员
• 时间
• 其他

接口录入辅助功能

• 导入json
• 使用模板
• 自动补全参数备注
• 录入提示
• 应用模拟请求返回值为参数值
• 其他

上图将常用参数保存为模板，下次录入的时候可以选择相应的模板

上图通过导入json方式录入参数，如果字段之前录入过那么会自动补全备注信息

上图将模拟请求的返回值直接应用为返回参数

任意多个返回值

一般情况下接口的返回值可能不止一种，可以根据自身业务录入任意多个返回值。

1. 接口展示页面

2. 接口录入页面

模拟请求

你可以在不借助其他工具或者插件的情况下，直接通过接口工具发送请求到服务器(类似postman)。

文档辅助

历史记录

对于文档的任何操作系统都会进行详细的记录。同时系统还会提供非常方便的查询过滤功能，你可以快速查询到相关的操作记录。

文档导出

我们目前提供三种方式的文档导出

1. 静态HTML文件 快乐摸鱼.html
2. 系统本身的JSON文档，可以用于备份文档或者处理为第三方工具适配的数据类型快乐摸鱼.json
3. 导出到其他项目，你可以选择将某个项目的部分接口导出到其他项目

你可以选择任意多的文档进行导出，或者将整项目一起导出

文档导入

导入对于迁移时非常重要的功能，我们想办法尽可能多的支持不同类型的接口导入。由于项目是开源的，我们提供了相关的导入接口，必要时用户可以通过直接调用接口的方式来导入第三方文档，当然我们希望未来有一套合理的插件机制来处理这个问题。

导入的文档会自动进行备注信息的匹配

在线分享

在对接第三方的时候，有时第三方用户并不愿意注册账号来使用工具。你可以通过生成在线链接来分享你的接口，这样用户就不必注册账号就能预览接口。在线链接，密码 111111

与导出的静态HTML不同，在线分享的接口会保持实时同步

模拟请求

后端开发人员一般会使用一些工具来发送请求进行联调，接口工具本身集成了发送请求的功能。

接口预览

我们将接口录入和接口预览分成了两个完全不同的模块，对于录入人员来说可以高效的完成接口录入，对于预览人员来说可以快速定位接口并且拥有非常直观的展示形式。

欢迎点赞+转发+关注！大家的支持是我分享最大的动力！！！