今天,互联网迈入了云原生的时代,DevOps持续开发运维的概念得到了普及。产品迭代速度极快,API数量爆发式增长,并且有70%到90%的业务是通过开源代码和第三方API来实现的。
文章目录
1️⃣API研发管理痛点2️⃣API一体化平台横空出世Eolink的出现强大功能API文档管理API测试进阶玩法 3️⃣总结
1️⃣API研发管理痛点
API接口管理目前遇到的最大痛点就是:开发时编写的大量文档在开发过程中需要经常改动,文档维护工作量由此变大。
做AIP接口开发的都知道,开发文档编写好之后,实际代码通常与文档有些许差别,想要保持代码与文档同步需要消耗很大的工作量。
之后若接口版本需要更新迭代,文档势必也要更新迭代,而接口调用本身具有依赖性,很大程度会成为接口开发人员对接时候的阻碍。
比如前端调用后端接口但功能无法实现,前端开发进度因此受到影响,特别是当接口变多时,调用、测试等工作复杂程度将消耗巨大的工程量,这过程太艰难。
在整个开发过程中,隐藏着许多不得不面对的问题,但主流的问题大致如下:
不愿意编写文档,但又不得不写API测试麻烦无法局部分享接口新接手项目没有文档2️⃣API一体化平台横空出世
API研发管理应该是大部分公司都会面临的一个管理问题,因此也有很多现成的轮子可以直接拿来用。
我们知道国产 API 接口管理工具近些年来不断崛起,API一体化平台横空出世,各种各样的管理工具层出不穷,但我接下来要介绍的这款强大的 Eolink ,你一定要知道!
Eolink的出现
Eolink 是一款专业级的一站式API协作平台,其团队早在2016年就发布了国内首个集各类单点工具于一身的开源产品Eoapi,并于2017年正式发布了全球首个在线API全生命周期管理平台。
针对API研发协作中的痛点,Eolink提出了创新理念:文档与测试驱动开发(DTDD),简单来说就是:
用标准文档代替口头约定和笔记文档,让开发、测试、运维、协作有迹可循;快速用测试结果推动开发进度,让团队沟通更充分、管理有事实依据,实现敏捷开发。其实一个产品是不是用心打磨过,体验好不好,一上手就知道了。
???体验地址:eolink.com
支持所有类型的 API 文档管理无论使用什么语言开发,无论是 HTTPS、Websocket、TCP、UDP 等什么协议,还是 Restful、SOAP、WebService 等什么规范,Eolink 都可以协助团队快速、统一、规范地管理起来。据不完全统计,Eolink 是目前支持语言、协议、规范最多的!
一键发起 API 测试,打通 API 文档与测试Eolink 可以一键发起测试,支持自动生成测试数据,能够通过 Javascript 代码对请求报文、返回结果等进行加解密、签名等处理。
零代码自动化测试,一键进行大范围回归测试当 API 发生变化时,可以一键进行 API 回归测试,系统会自动根据规则判断返回结果并得出测试报告,方便团队快速了解 API 改动的影响范围,可减少超过 95% 的测试时间!
强大的 COOKIE 管理功能在测试需要 Cookie 的 API 时,Eolink 支持在 Cookie 管理里添加所需的 Cookie 信息,系统会自动存储 Cookie,下次测试其他相同域名的 API 时会自动传递 Cookie 请求参数。
Eolink 强大的 API 管理功能,可以全面提升 API 开发、协作和测试的效率。
强大功能
API 研发过程复杂,涉及前后端开发、测试多团队协作沟通,工作繁琐工作量巨大,市面上有众多 API 研发工具基本能满足 API 研发基础需求,但Eolink 依然在功能的深度、广度以及用户体验等方面都做到了更好,尤其是针对批量操作和重复工作开展了大量自动化和智能化提升。
Tips:目前 SaaS 产品完全免费,可以使用 web 版,也可下载桌面端,Windows、Mac、Linux 平台均支持!
接下来让我们看看,Eolink 到底有多强!
API文档管理
新增 API 文档:
(1)手动创建 API 文档, API 研发管理平台提供了十分全面的 API 文档格式,能详细记录 API 信息。
(2)可以绑定 Github 、 Gitlab 、码云等代码仓库,兼容 Swagger 代码注解生成 API 文档的方式,实现一键自动生成 API 文档。
API 文档变更通知:
API 研发管理平台提供了变更通知功能,当 API 发生变化时通过邮件和站内信自动通知相关成员,并且显示变更的内容,实时掌握变更动态。
查看、回滚、对比 API 编辑历史:
您可以随时回滚到任意一次 API 文档版本,并且还可以对比两个版本之间的差异。
API测试
页面入口进入 API 文档详情页,点击上方 测试 标签,进入 API 测试页,系统会根据API文档自动生成测试界面并且填充测试数据。
首先填写好请求参数。
3. 填写好请求参数后,点击测试按钮即可得到测试报告,报告包括以下内容:
在使用中我们可以很方便的设置API的各种状态,方面同组一起协作的开发同事及时看到API的状态。
还可以回滚查看API文档历史版本,智能查找不同版本文档差异!!!
进阶玩法
在使用的过程中,我还发现了 Eolink 几个隐藏的亮点功能,用起来特别香!强烈建议大家前去探索一下~
1、API变更智能通知
2、API历史版本比对
3、项目分析报表
4、超强Mock API
5、API文档评论功能
6、定时测试任务
7、支持数据驱动
直接上图,一看就懂。
当 API 发生变化时通过邮件和站内信自动通知相关成员,并且已与QQ和飞书打通
回滚查看API文档历史版本,智能查找不同版本文档差异
强大的项目数据统计分析功能和醒目的可视化呈现,团队开发工作一目了然
简易Mock功能,减轻Mock规则编写压力
智能Mock功能,实现Mock规则零配置
3️⃣总结
前端、后端、测试、管理等多岗位可同时开展工作,无需互相等待,高效敏捷;后端在平台内快速编写、生成API文档,基于 API 文档来讨论、确定开发内容;前端基于API文档快速生成 Mock API,在后端没有开发完成的情况下可先进行前后端对接;测试基于API文档快速编写测试用例,当API开发完成后可一键进行冒烟测试;后端可通过测试用例自行对API的改动进行回归测试,减少大量沟通、测试时间;API 验收完成后可将测试用例组合成自动化测试流程,后续每次版本迭代、代码提交后可自动触发大范围回归测试,整体效率、项目质量得到极大提升!看了这么多,你一定迫不及待地想亲自体验一把!快上手吧~