活久见：都 2203 年了，你还在使用 word 调试 API

Posted 2023-02-17 不吃西红柿丶

随着信息技术的发展，API 变得无处不在，无处不用。但令人费解的是，都 2203 年了，竟然还有很多人使用 word 调试 API？

今天，西红柿将带领大家打开新世界的大门，放下诺基亚，抄起智能机！！！

有些小伙伴可能不理解，什么是 API，详见：
什么是 api ！！！

一、Word 管理 API vs 工具管理 API

不做开发的小伙伴可能感受不到，使用 Word 交流 API，首先需要 API 开发人员，编写 word 文档。受制于每个人的文档能力，编写习惯参差不齐，读者往往会非常痛苦。

随着 API 的不断修改迭代和调试，同一 API 的文档版本会越来越多，管理起来极其费劲，文档传递 one-by-one 口口相传，项目整体开发效率可想而知！

除此之外，传统的 API 管理，只是维护了一下 API 文档，用 word 文档或者 wiki 等把 API 简单描述。这种模式在互联网是的敏捷开发的背景下，难免会出现诸多问题：

1. API 文档编写不规范：缺乏统一文档格式，简写、漏写或不写详细说明（开发人员总觉得自己看得懂即可）。
2. 储存平台不统一：公司内部每个项目团队都有自己的使用习惯，甚至一个项目内部可以同时存在多个 API 管理工具，平台不统一导致无法高效维护和协作。
3. 文档更新不及时：开发团队习惯于先开发后补文档，认为文档对于开发工作而已是一个附加的内容，导致更新不及时。
4. 变更历史不记录：由于没有及时维护文档，当需要回头检查项目或进行工作交接时就会发现看文档不如看代码，反而拖慢工作进度。
5. 测试人员无法快速编写测试用例：由于传统 API 文档仅仅是个文档，测试人员还需要使用其他工具编写测试用例。
6. 并没有降低沟通成本：由于上述原因，前端、后端、测试、运维等成员经常由于不清晰的文档而引发争论，有时候反而增加了沟通成本。

如图所示，接口文档 无法跟开发和测试的环节联动，你开发你的，文档始终慢我一步。没有有效的 API 管理协作模式，不仅大大增加开发成本，甚至会影响项目进度。

但其实，这个尴尬的难题早就被攻克了。高级程序员早就使用工具管理 API 了，他的工作模式是这样的：

可以看到，接口文档 跟开发和测试的环节完美联动，有变化能第一时间通过，自动生成 api 文档获取到，同时，自动生成的专业化 api 接口文档，格式可读性更强，内容更加丰富详实。

二、国内 API 工具天花板

这些 API 管理的困境，也让一些企业嗅到了商机，以 Eolink 为代表的公司，也在很早就开始布局，积极投入研发力量，经过大量实践探索，打造出了一款天花板级别的全生命周期管理的 api 工具！！

现在，放下诺基亚，抄起iPhone。我将为大家详细介绍，顺带附上官网体验链接：- API 管理工具：https://www.eolink.com/

全生命周期 8 大解决方案：

每一项细分功能如下：

Eolink API 研发管理平台是一个集 API 文档管理与快速测试于一体的 API 协作研发平台，属于 Eolink API 全生命周期管理产品生态中的重要基石。

Eolink API 研发管理平台基于 Eolink 提出的创新理念：文档与测试驱动开发（DTDD），规范管理和测试所有 API。联动前端、后端与测试人员，构建敏捷团队，统一管理 API 相关数据，帮助团队内部共享工作成果。并能通过与其他系统对接，强化 DevOps 能力。

2.1 设计

通过 API Studo，可以方便快捷的设计 API 文档，

API 编辑页面中可以填写 API 文档、返回数据、额外说明等信息，您可以通过顶部的标签切换。

2.2 创建

在 API 研发管理平台 中，您可以通过三种方式来创建 API 文档：

1. 手动创建 API 文档，API 研发管理平台提供了非常全面的 API 文档格式，能够详细记录您的 API 信息。这种方式适合所有用户，并且也是我们推荐的方式。
2. 关联项目与 Swagger URL，API 研发管理平台自动从该地址获取最新 API 文档。这种方式适合之前已经在使用 Swagger，并且倾向于将文档写在代码注解中的用户。但这种方式会带来代码入侵的问题，让代码中加入了许多无关的信息从而增加维护成本。
3. 关联项目与代码仓库，API 研发管理平台自动从代码仓库中扫描代码注解生成 API 文档。目前这种方式支持 Java 以及 php 两种语言。这种方式也会带来代码入侵的问题。

2.3 测试

进入 API 文档详情页，点击上方 测试 标签，进入 API 测试页，系统会根据 API 文档自动生成测试界面并且填充测试数据。

测试用例支持对返回结果进行校验，以下是几种结果校验规则：

校验方式	描述
不校验	无论返回结果是什么，均认为测试通过
校验状态码	判断响应头部中的 HTTP Status Code
校验 JSON	判断响应结果的 JSON 结构和参数值，可以判断对象、数组、字段等信息
校验 XML	判断响应结果的 XML 结构和参数值，可以判断对象、数组、字段等信息
完全匹配	判断响应结果是否等于预期结果
正则匹配	通过正则表达式去匹配响应结果，如果匹配的结果集不为空，则认为测试通过

2.4 监控

加强监控协作的第一步就是确保 API 的可见性和对项目的共享。我们可以使用 eolink 监控功能轻松实现。每个人都可以了解到所关注 API 的开发，修改，上线等情况。

• 当 API 状态变为“开发”时，通知后端开发；
• 当 API 变为“对接”时，通知前端进行对接；
• 当 API 变为“测试”时，通知测试人员进行测试；

设置当 API 删除或异常时，通知某位成员。

2.5 管理

API 研发管理平台 提供了变更通知功能，当 API 发生变化时通过邮件和站内信自动通知相关成员，并且显示变更的内容。

• 产品经理：可以将接口状态设置为“已发布，设计中，待确定”
• 后端研发：可以将接口状态设置为“待确定，开发，对接，异常、维护、废弃”
• 前端研发：可以将接口状态设置为“测试，异常”
• 测试人员：可以将接口状态设置为“完成，异常，维护”

三、核心功能介绍

1. 支持所有类型的 API 文档管理

无论使用什么语言开发，无论是 HTTPS、Websocket、TCP、UDP、HSF、gRPC、DUBBO 等协议，还是 Restful、SOAP、WebService 等规范，Eolink 都可以协助团队快速、统一、规范地管理起来。

2. 一键发起 API 测试，打通 API 文档与测试

Eolink 可以一键发起测试，支持自动生成测试数据，能够通过 javascript 代码对请求报文、返回结果等进行加解密、签名等处理。一键发起，让繁琐的 API 测试变得简单顺滑。

3. 零代码自动化测试，一键进行大范围回归测试

当 API 发生变化时，可以一键进行 API 回归测试，系统会自动根据规则判断返回结果并得出测试报告，方便团队快速了解 API 改动的影响范围，可减少超过 95% 的测试时间！

4. 根据 API 文档生成 Mock API

Eolink 支持非常强大的动态 Mock API，可以根据不同的请求参数自动返回不同的 HTTP Status Code、Header、Body 等数据，并且支持在一个 API 文档里创建多个 Mock API 。

5. 强大的 COOKIE 管理功能

在测试需要 Cookie 的 API 时，Eolink 支持在 Cookie 管理里添加所需的 Cookie 信息，系统会自动存储 Cookie，下次测试其他相同域名的 API 时会自动传递 Cookie 请求参数。

四、小结

使用API工具替代WORD的管理API的方式，除了在开发/测试/管理/迭代等方面的表现出强大优越性，还有许许多多让人眼前一亮的功能，等待你亲自尝试。

官网体验链接：点我体验 API 专业工具

不得不佩服 eolink 的开源格局，希望Eolink 越办越好，造福国内程序员。