一、学弟突然向我请教……
突然某一天,一个特别能卷的学弟向我请教接口工具……
二、Eolink到底是何方神圣?
最近国产API管理工具卷起来了,很多管理工具目不暇接,但到底哪家强?这里给大家推荐Eolink,低调又强大。
Eolink是结合了 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 生产平台,还集成 Gitlab、Jenkins、钉钉、企业微信、飞书等平台,简直就是一个六边形战士,没有短板!亲测好用!!!
牛皮不是吹的,火车不是推的!推荐Eolink是因为人家研发API管理工具最早,产品线最全面,目前Eolink在商用方面已全面领先!据官方数据,他们已经服务了超3万家企业客户!
体验地址:https://www.eolink.com/?utm_source=w3805
接下来就让我们展开看看,Eolink到底强在哪里!~
超强的 API 管理功能
Eolink支持 HTTP(S)、Websocket、TCP、UDP 等主流协议,通过代码注解自动生成 API 文档,或者从 API 文档反向生成所有常见开发语言和框架的代码,节省 API 设计和开发时间。强大的 API 版本和变更管理让你不放过 API 的任何变动。支持所有主流协议:代码自动生成、API 文档、API 文档自动生成代码、API 版本管理、API 变更通知。
超方便的 API 测试功能
Eolink支持多种方式快速发起 API 测试,自动生成随机测试数据和测试用例,一键对 API 进行批量回归和冒烟测试,并且立刻得到丰富详细的测试报告,让繁琐的 API 测试变得如此简单。
支持在线、本地、客户端进行测试;一键进行回归/冒烟测试;快速创建测试用例;自动生成测试数据;丰富详细的测试报告。
0代码的 API 自动化测试功能
Eolink中不需要编写代码,通过拖拉拽即可创建 API 测试流程,API 文档和测试步骤自动关联,当 API 文档发生变化时自动同步到测试用例,极低的学习和维护成本。并且通过定时自动测试将测试报告推送到邮箱、钉钉、企业微信、飞书、Jenkins 等平台,与 CI/CD 流程无缝结合。
丰富的团队协作与持续集成能力
Eolink强大的权限和项目管理功能,一键分享API文档、离线导出各种格式、通过Open APl与各种平台快速结合。Eolink APIKit 提供了满足API团队协作和流程自动化的所有功能。
体验地址:https://www.eolink.com/?utm_source=w3805
三、Eolink如何解决后端开发的痛点
3.1 后端开发岗位的普遍痛点
在进行API接口相关的研发工作流中可见,后端工程师与前端工程师约定好接口后,就会进行接口文档的编写,并进行接口的代码开发。在这个过程中会对接口文档不断的进行修改,同时接口开发的过程中也会在不断地进行接口自测调试。接口基本无误后,会编写单元测试用例,并进行单元测试。最终单元测试通过后会和前端工程师进行前后联调,以及进行后续的缺陷修复。
在上述的整个开发过程中,就隐藏着许多后端不得不面对的问题,但主流的问题大致如下:
3.1.1 不愿意编写文档,但又不得不写
写接口文档是很枯燥乏味的工作。往往写好一个规范的接口文档也不会让后端工程师有特别的成就感,但写好一个接口文档需要填写各个琐碎的字段。
所以一般后端开发者都更加愿意把时间花在编码上,草草的应付接口文档的编写工作。
但是在研发团队协作中接口文档编写是否规范,将影响到其他调用方对该接口的理解,并且文档是否详实一定程度上决定了对接联调的时间。
3.1.2 API测试麻烦
在接口开发过程中,需要频繁的进行接口文档调整,自测接口是否能输出想要的结果。
这时候一般就会遇到一个问题,传统接口工具的测试比较单一,且测试数据编写麻烦,返回错误是不容易定位的。
接口开发过程中,这样的调试过程需要循环多次,给我们带来了极大的不方便~
3.1.3 无法局部分享接口
一般swagger文档是以某个服务为整体管理该服务下的API接口文档。
在联调过程中,后端工程师需要把新增的或需要联调的多个接口分享给对接人时,只能把整个服务文档地址分享出去。然后截图告知是哪几个接口是本次有变更的,或者本次需要对接的。
但上述这个过程对于对接联调来说,十分的不便!
3.1.4 新接手项目没有文档
在日常的软件团队开发过程中,经常会遇到需要借调或接手一个新项目。
但很多时候会遇到新接手的项目没有任何接口文档,或者文档并不规范。并且这个时候“前人”已无法联系了,这座代码*山变成了不可攀越的高峰。
3.2 Eolink是如何解决上述这些痛点的?
3.2.1 根据代码生成文档
Eolink提供IDEA插件,可以基于代码一键生成API文档并同步到Eolink对应的项目中。接口文章除了提供展示标准的基础信息、请求参数、响应参数等字段后。
还可以增加例如字段额外说明,标签,接口状态等信息。若需要更加规范的文档内容,那么Eolink提供API文档模板和数据结构的功能,可以按各公司的需要生成对应的模板,开发者直接复用减少重复工作的同时,使得文档更加规范可读。
3.2.2 便捷的调试体验和自动生成测试数据
Eolink 的API文档中文档编辑和测试是两个相邻的功能按钮,符合后端工程师日常的工作场景。
编辑完文档后,可快速切换到测试界面进行调试。并且系统会自动根据文档参数类型和约束条件,自动填入测试数据,后端工程师仅需点击测试按钮即可完成接口调试,省时省心更省力~
3.2.3 支持多场景分享文档
Eolink 支持多种场景的API文档分享。可和swagger一样把全项目接口文档进行快速分享,也可以设置分享文档的可见范围,仅分享本次对接相关的接口。
也可以对文档设置分享密码,提高资产安全性。更可以把测试用例等信息同步分享,调用方可快速使用测试用例了解接口返回情况。
3.2.4 标准规范的API管理工具
Eolink是一个一站式智能协作的API管理平台,能把企业内所有的项目按自定义的标准规范模板,沉淀在统一的API接口仓库中。
所以无论前后端工程师去到哪个项目,即可获得一份熟悉又标准的接口文档供咱们使用上手!~
体验地址:https://www.eolink.com/?utm_source=w3805
3.3 其他的一些隐秘又好用的小功能Tips!~
还发现Eolink几个隐藏的亮点功能,用起来特别香!强烈建议大家尝试一下~
1、API变更智能通知
2、API历史版本比对
3、项目分析报表
4、超强Mock API
5、API文档评论功能
6、定时测试任务
7、支持数据驱动
四、学弟的反馈
在使用中我们可以很方便的设置API的各种状态,方面同组的开发同事或伙伴及时看到API的状态。
在写好接口后,我们还可以快速的编辑好对应的接口文档,方便前后端进行对接!
还能看见十分全面的API各类数据报表,对整个项目都一览无余~
体验地址:https://www.eolink.com/?utm_source=w3805
五、写在后面的话
大量数据表明,通过Eolink,能够提高 60% 的整体研发效率!用标准文档代替口头约定和笔记文档,让开发、测试、运维、协作有迹可循;快速用测试结果推动开发进度,让团队沟通更充分、管理有事实依据,实现超敏捷开发。以下是Eolink功能一览~
前端、后端、测试、管理等多岗位可同时开展工作,无需互相等待,高效敏捷;
后端在平台内快速编写、生成API文档,基于 API 文档来讨论、确定开发内容;
前端基于API文档快速生成 Mock API,在后端没有开发完成的情况下可先进行前后端对接;
测试基于API文档快速编写测试用例,当API开发完成后可一键进行冒烟测试;
后端可通过测试用例自行对API的改动进行回归测试,减少大量沟通、测试时间;
API 验收完成后可将测试用例组合成自动化测试流程,后续每次版本迭代、代码提交后可自动触发大范围回归测试,整体效率、项目质量得到极大提升!
快来上手吧~ Eolink体验地址:https://www.eolink.com/?utm_source=w3805
点击对应版本下载即可使用!~
目前的官网产品中, SaaS 产品是完全免费的,可使用 web 版,也可下载桌面端,Windows、Mac、Linux 平台等多个平台都是支持的!