API接口在设计时每每须要编写大量的文档,并且编写完成后每每须要根据实际状况,常常改动文档,文档编写维护工做量相对较大,有点头疼。git
因为咱们项目还常常会由于交付周期的缘由,须要接入一个第三方的库,而第三方的库一般都存在文档老旧,文档不够全面等等或多或少的问题。那这个问题相比于没有文档,对程序员来讲更加难以棘手。由于会形成:咱们须要的接口不在文档上,文档上的接口不存在库里,又或者是少了一行关键的代码。 程序员
而后我在网上找解决办法,找到了eoLinker,做为苦逼的开发,在此分享我一些使用过程当中的心得,但愿都能脱(ji)离(xu)苦(kai)海(fa)。
接口信息清晰了
没有文档的库,就比如一个黑盒,咱们没法预期它的正常行为。输入了一个 A,预期返回的是一个 B,结果它什么也没有。有的时候,还抛出了一堆异常,致使你的应用崩溃。
而接口信息模糊冗杂,不但加大了开发人员理解的难度,还增长了无谓的沟通成本,拖延项目进度。 为此,咱们在编写接口时,应考虑完善,接口录入信息清晰有条理,避免含糊不清的用词和参数。
接口更新及时
随着接口版本的迭代开发,接口信息有所变化,旧文档已经不能知足接口的要求,开发者能够经过对相应接口文档的接口操做,根据现有接口信息进行从新录入,快速保存为接口的新文档。
接口操做历史可溯源
相似gitHub,接口文档的每一次改动历史应清晰记录下来。在后期接口管理和维护上,经过对操做历史的查看,开发者能够了解到每次改动的目的和内容,进而科学管理接口。
eolinker AMS记录了接口文档近十次的操做历史,支持接口历史一键回溯功能,下降了成员对接口文档误操做的风险。
成员权限有所限制
在项目开发中,因为每一个团队成员在项目中担任的角色不一样,他们对接口文档应有不一样的操做权限,以确保相关接口文档的完整性和安全性。 eolinker AMS提供了灵活的权限管理,经过分配适当权限给相应成员,保证开发时文档不被无关人员篡改。
接口测试同步完成
编写完接口文档后,为验证接口返回值是否符合接口文档所描述的预期结果,开发者们须要对接口进行测试。
eolinker AMS提供接口本地一键化测试功能,只要将信息录入eolinker接口管理平台,你将会省去将接口信息从新复制到测试工具的操做。你只须要点击测试页面,输入测试参数值,即可完成测试。
还提供mock测试功能,经过设置假数据以验证接口的可行性。
以上!