如何基于 eolinker 的进行接口管理

Posted 2020-10-14

由于工作的原因，经常要接触到很多API接口，而API接口在设计时往往需要编写大量的文档，而且编写完成后往往需要根据实际情况，经常改动文档，这使得文档编写维护工作量相对较大，这让我也包括很多的开发者都很头疼。
此外，伴随着接口版本的迭代开发，接口文档也需要同步更新。而且接口开发完成以后，做接口测试会十分不方便，要是遇上接口数量多、参数负载的情况，那不仅不方便，测试工作量会重上加重。
我们还经常会因为交付周期的原因，需要接入一个第三方的库，而第三方的库通常都存在文档老旧，文档不够全面等等或多或少的问题。那这个问题相比于没有文档，对程序员来说更加难以棘手。因为会造成：我们需要的接口不在文档上，文档上的接口不存在库里，又或者是少了一行关键的代码。
上述的问题其实让我在工作中很苦恼，后来经过前辈推荐eoLinker，使用了一段时间后，发现这个工具的开源版是基于php框架的，用起来的确还能解决一些问题。感兴趣的可以去了解一下，在此我分享一些使用过程中的心得。
【接口信息清晰完善】
没有文档的库，就好比一个黑盒，我们无法预期它的正常行为。输入了一个 A，预期返回的是一个 B，结果它什么也没有。有的时候，还抛出了一堆异常，导致你的应用崩溃。而接口信息模糊冗杂，不但加大了我理解的难度，还增加了无谓的沟通成本，拖延项目进度。为此，我们在编写接口时，我一般都会考虑完善，接口录入信息清晰有条理，避免含糊不清的用词和参数，后续也能查看和修改。

【接口文档更新及时】
因为随着接口版本的迭代开发，接口信息有所变化，旧文档已经不能满足接口的要求，我可以通过对相应接口文档的接口操作，根据现有接口信息进行重新录入，快速保存为接口的新文档。更新及时的功能算是我最喜欢的功能了。
【接口操作历史可溯源】
类似gitHub，接口文档的每一次改动历史应清晰记录下来。在后期接口管理和维护上，我只要通过对操作历史的查看，就可以了解到每次改动的目的和内容，进而更加方便管理接口。目前发现可以记录了接口文档近十次的操作历史，也支持接口历史一键回溯功能，算是一定程度上降低了成员对接口文档误操作的风险。

【成员权限有所限制】
在项目开发中，由于每个团队成员在项目中担任的角色不同，我必须让他们对接口文档应有不同的操作权限，以确保相关接口文档的完整性和安全性。eolinker 提供了灵活的权限管理，通过分配适当权限给相应成员，保证开发时文档不被无关人员篡改。这也是我用的比较多的功能。

【接口测试同步完成】
编写完接口文档后，为验证接口返回值是否符合接口文档所描述的预期结果，我是需要对接口进行测试。eolinker也提供接口本地一键化测试功能，只要将信息录入eolinker接口管理平台，就不必将接口信息重新复制到测试工具的操作，这让我觉得很方便。我只需要点击测试页面，输入测试参数值，便可完成测试。也提供mock测试功能，通过设置假数据以验证接口的可行性。



这样管理接口对于我来说的确让工作简单了一些，今天主要是分享了我经常用的功能点，如果有机会的话再分享多一点使用经验。