---

前言

本人是一名前端，在遇到Eolink之前，一直使用几个不同的工具与后端进行api的调试工作，其中yapi、showdoc等查看api文档，postman工具调试api数据。
在这个过程中，我觉得以下问题会影响工作效率和体验：

• 多个api工具切换，说实话很麻烦，如果查看文档和调试数据能在一个工具里，一步到位就好了。
• 多个项目使用多种api文档，swagger，yapi等等，这些工具之间的api数据不能完美兼容迁移，不同的项目需要用不同的工具查看。
• mock数据在前端生成，要与后端随时沟通，了解后端的数据结构。
• 后端更改接口格式没和前端说，导致前端测试出问题，浪费调试时间。

而接触并使用了Eolink后，基本解决了上述的问题，提高了我的开发效率，接下来是我的使用体验与心得。

---

一、Eolink是什么？

一句话概括：专业的一站式api协作管理工具。一站式指的是Eolink的全能，它囊括了api文档管理，自动化测试，团队协作，mock测试等一系列和api相关的功能，基本覆盖了api的设计、开发、对接、测试、运维等大部分工作。

二、Eolink使用与心得

进入Eolink官网，可以下载不同平台的客户端（有linux版本好评👍🏻），其实官方也提供了网页端，只要注册并登录成功后，点击网站右上角的进入产品可以进入网页端。
我使用的就是网页端，前端开发和api管理不用再切换软件，美滋滋😁，工具内部提供了很好的示例，方便小白快速入门Eolink，以下使用记录基本都会以官方示例做示范。

1.api文档

前端和后端协作，最重要的媒介莫过于api文档，文档是否专业好用直接影响着前后端的协作成本与效率。Eolink提供了专业的文档管理，基本的api书写，分类，文档导出，角色权限等都有提供。

项目权限

api的最高层级是项目，所以管理api从创建一个项目开始，官方提供了示例项目，我们可以为项目添加成员，设置权限，对于权限角色，官方支持自定义，提供了很多动作供我们选择。

文档迁移

对于之前的老项目，即便使用不同的的api文档工具也可以做到完美迁移，项目这边提供了导入功能，对于一些常用的api文档都做到了兼容，再也不用开一个项目，换账号登录文档了😂。对于支持导入的文件类型，可以点击“查看详细说明”，会跳转到官方文档说明。

2.api调试

接下来点击示例项目，我们进入到工具的核心，api管理。

基本功能

首先从创建一个api请求开始，Eolink提供了丰富的创建选项供我们选择，例如：请求参数、请求头、返回结果、返回头、成功和失败的返回示例，我的的postman可以光荣退休了😄。

对于已经创建好的api请求，现在就可以开始调试了。Eolink提供了专业且丰富的调试功能，api各项请求数据都很详细，特别是发送请求时，可以使用自己设置的测试用例，方便各种情景的调试，对于测试人员可以说是十分又好了，既可以测试单独api，也可以在后期统一测试所有api。

高级mock

当后端api未开发完成，但已确定数据结构时，为了不耽误前端工作，可以使用mock数据代替api真实数据。Eolink提供了高级mock功能，支持mock规则生成数据。
在创建api对应的mock时，选择JSON格式可以自定义对应mock的请求结果

添加mock之后，官方会提供远程的mock api链接，我们可以把代码中的接口地址改为这个远程api地址。及时后端未开发完成，也可以使用mock数据来调试前端效果

3.api测试

api的测试是验证api质量的重要步骤，测试人员可以测试单个接口的场景，根据场景的不同去创建一系列测试用例。例如：官方提供的用户登录测试用例，包含登录成功和失败的场景，可以测试单个测试用例，也可以批量测试。

点击左侧导航的“api测试用例”，可以管理本项目所有接口的测试用例，对于某个功能，可能需要多个接口有序进行才能进行完整的测试，如：获取积分功能，需要等待登陆成功后才能正常使用，这时我们可以按顺序选择对应的接口进行。

4.api变更通知

后端更改api后应该及时通知前端，不然可能会浪费大量的前端调试时间，之前有几次就是api的返回结果更改了，前端实在找不到问题后，去问后端才发现改了接口数据结构，如果api文档一旦更改，工具会帮忙通知相关负责人就好了。现在有了Eolink，它可以快速通知其他组员api的变更，有两种方式触发通知，基本满足我的需求。

4.1通知方式

保存时通知

更改api后，点击”保存“，可以触发更改通知，例如这里，我们把状态从已发布改为异常，点击保存。

之后会有弹框，这里最好写上更新描述，减少沟通成本，这时再点击”确定“就会通知到相关人员。

确认触发变更通知后，我们切换到另一个组员，点击右上角的铃铛，进入站内通知。

在消息中，我们可以找到对应接口的变更记录。

直接在文档中更改状态会触发通知

点击文档中的铃铛，可以设置具体的通知人员和范围。

4.2 使用第三方通讯工具发送变更通知

站内的通知其实并不显眼，如果不是自己主动打开站内通知的话，基本就错过了，所以最好的还是通过平时使用的钉钉，企业微信，飞书等来发起通知。Eolink提供了webhook功能，可以使用聊天机器人发送消息，接下来我以钉钉为例，创建一个对应的通知功能。

• 点击右上角API管理，进入空间管理
  
• 点击webhook，点击添加服务调用，准备添加webhook
  
• 填写服务调用的各种内容
  
  最后一个签名密钥不需要填写，注意推送格式选对，我用的钉钉，这里的格式就选钉钉。
  触发事件可以按需选择，对于几种主流的工作通讯工具的通知url获取，Eolink的文档里有详细说明，详见webhook帮助
• 接收通知
  创建webhook后，去更改某个api的文档，就可以在通讯工具里接收到变更通知啦😄
  

对Eolink的一点建议

• api文档保存时的更新描述能否默认显示在webhook通知里，减少沟通成本。

总结

虽然这次只体验了Eolink的一部分功能，但是Eolink确实解决了我在api调试中的几个痛点，后面我会熟悉Eolink的其他功能，如果能满足我们当前的工作需求的话，我会很乐意把它推荐给我的后端同事😁，希望Eolink火起来能被更多人知道。