本文导读
-
- 为什么要选择 Eolink
- Eolink 概述
- Eolink 实操演示
-
- 1. Eolink 的安装下载
- 2. 项目管理
- 3. API 管理与测试
- 4. 分析报表
- 写在最后
为什么要选择 Eolink
随着软件开发前后端分离架构设计的流行,敏捷开发、版本迭代的需求可以说是更加频繁,那么对于 API 接口文档也就显得越来越有必要了。 作为一名开发者,我也使用过几款 API 管理工具,从一开始广为人知且具有代表性的 Postman
(印度),我就用了很长时间,对于一般的接口测试它可以胜任,但并不是所有业务都能够满足,集成度有所欠缺。
后来有了机会开始了解国产 API 管理产品,截止目前我先后体验过的有 Apipost
、Apifox
以及本文要介绍的 Eolink
,在用过这些国产软件之后,我自己最大的体会:还是国内厂家更能了解我们国内开发者的需求,无论是从功能模块的深度广度,还是说可操作性、便捷性、用户体验等来看,国产工具显然更对我们的胃口(国人更懂国人)。
从个人体会来看,三款(国产)工具对于 API 接口的设计、接口文档和测试的都能很好的解决。我认为 Eolink
最大的优势在于针对批量操作和重复工作开展了大量自动化和智能化提升,我尤其看好的是它强大的权限和项目管理功能,提供了满足 API 团队协作和流程自动化的所有功能,综合下来最强。接下来我们认识一下它:
Eolink 概述
Eolink 是一款免费的国产 API 管理协作神器,正如它的主题语 —— “专为开发者设计的免费 API 协作平台” 一样,Eolink 平台是免费的、以 API 为核心进行拓展的,结合 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 生产平台。
- 几乎支持所有主流协议;
- 可通过代码注解自动生成 API 文档以及反向生成常见开发语言的代码;
- 支持多种方式快速进行 API 测试,自动生成测试数据和用例;
- 一键回归批量回归 API 和冒烟测试,测试报告详细丰富;
- 无需编写代码,拖拉拽即可创建 API 测试流程,API 文档与测试步骤关联;
- 定时自动测试,测试报告自动推送,可推送至邮箱、钉钉、飞书等众多平台;
- 支持 API 在线分享、离线导出,以及 API 版本的管理;
- 项目人员角色与权限管理,Open API 丰富,可与众多主流平台集成。
Eolink 实操演示
1. Eolink 的安装下载
想要安装 Eolink 只需前往 Eolink 官网 直接下载即可,提供 Windows、MacOS、Linux 三种客户端版本;
当然,也可不下载客户端,直接使用 Web 版本,前提是要注册并登录账号。客户端和 Web 端可以互通,并不影响数据的同步。
2. 项目管理
当我们登录进入软件之后,首先看到的是项目管理界面;
点击“+添加”可以在此新建项目;
如果说我们之前的项目使用的是其他第三方 API 托管平台,现在想要将项目切换到 Eolink 平台,它也提供了导入功能,支持多方平台的导入;
此外就是权限管理,它是基于角色的。添加一个新角色时可指定该角色所拥有的权限,包含 API 管理、项目文档管理、环境管理等;
然后我们在这个角色中再添加成员即可拥有对应权限。项目管理更加细致,团队成员责任更加明确;
3. API 管理与测试
当我们创建好项目后,就可以对项目进行 API 的管理与测试了,我这里以示例项目为例;双击进入示例项目,可以看到项目中用户模块下的若干 API;
对于每一个 API,都会展示明确的协议、请求方法、各参数以及返回示例(成功&失败)等;
此外不得不提的一个功能就是对 API 版本的管理,我们可以查看历史每次对 API 做出修改操作的详细时间以及操作人和操作详情,对于版本的回退和责任人的发现无疑有着极大的便利;
当某成员对 API 做出了修改时,直接点击通知按钮即可将自己做出的改变通知给项目成员,或者做出评论后再通知,协作效率极高;
在 API 文档的编辑这一栏,我们可以清楚的看到当前 API 处于生命周期中的哪一个阶段,这对开发者还是使用者都清晰明了;
也可以对该进行其他的设置包括路径、名称、各类参数、请求、响应等等,甚至可以直接指定负责人;
此外还有测试用例、Mock ,Eolink 已经为我们提供了 Mock 服务器,我们只需添加 Mock 操作即可;
API 的管理中也提供了状态码文档,用于展示类型状态码以及描述,支持分组添加;
在环境模块中,可以添加不同环境以及不同变量,轻松实现多环境的测试;
在公共资源模块中,支持添加数据结构、自定义函数和 API 文档模板;
拿数据结构类型下 userinfo 举例,它是整个用户信息的封装,在一次定义之后就可以直接其他位置进行引用;
如下,数据结构 userinfo 被引用在用户登录 API 中;
点击进入用户登录 API,可以在 API 描述下看到它们的关联性,我们可对其进行相关操作;
4. 分析报表
Eolink 还有一个非常好的点在于它的可视化分析报表功能,我们可以在界面中快速了解到工作空间内 API 各项指标,包括项目数量、API 数量、测试用例数量、状态分布数量、API 变成 BUG 次数、API 改动情况等,支持按照周期和 API 标签进行统计,团队项目状况一目了然。
写在最后
通过这些操作,不难看出,虽说对于 API 的管理操作方法各厂商大体上都是一脉相承,但是相对来说 Eolink 的确是做的更加细致,这个本人是深有体会,对大部分功能均细节性的进行了补充,此外还具有着更新颖的功能,功能特性可以说是更深也更广。还有我个人最看好的团队的协作方面,Eolink 真正将便捷高效做到了极致。
以上就是小马对 Eolink 的相关介绍,由于篇幅等原因这里仅作部分演示,更多高级的功能还得自己实际上手体验了才知道,期待大家亲自上手操作,相信会有一种全新的感受。
Eolink - 专为开发者设计的免费 API 协作平台