代码编织梦想

一、API爆炸的时代

 

随着最近行业的移动化、物联网化、数字化转型、微服务等多种概念的提出,对应的 API 数量已经呈现出爆炸式增长,由此带来的问题就是前后端的接口对接问题越来越来突出,我们能很难找到一个合适的技术工具提高我们的效率。由此带来的问题就是接口对接的繁琐,前端后端日常吵架。

1.1 背景介绍

现在我们其实有很多的 API 工具,在 API 文档设计有大名鼎鼎的 Swagger,API 开发调试我们有 Postman、前端开发用的比较多的式 Mock.js、自动化测试我们拥有 JMeter,但是由于是多个软件,我们需要多次的输入相同的重叠数据到不同的系统才能实现我们需要的功能,而且在项目发生变更的时候我们就不得不进行多个地方的修改,一不留神忘记修改就是 boom。

1.2 问题引出

所以为了应对上面的需求,我们需要的就是将这几个常用软件可以融合到一起,如果能够做到数据完全互通,当我们修改一个地方的时候所有地方都进行修改那就太完美了。

1.3 解决方案

 

Apikit 是结合 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 生产平台,从个人开发者到跨国企业用户,Apikit 帮助全球超过50万开发者和10万家企业更快、更好且更安全地开发和使用 API。

体验链接:

https://www.eolink.com/?utm_source=cpcs&utm_content=cpy16

二、核心功能

2.1 API文档

Eolink Apikit支持强大的API文档管理功能,包括多种创建文档的方式,导入导出,版本管理,查重等。

 

 

2.2 API调试

当我们创建好 API 文档之后,可以立刻对该 API 进行测试,API 研发管理平台 提供了以下主要特性来帮助测试人员快速发起 API 测试:

  • 支持本地测试、局域网测试、在线测试等;

  • 支持一键切换测试环境,使用全局变量、增加额外请求参数、改变请求地址等;

  • 支持直接在界面编辑 JSON、XML 请求数据,不再需要手写 JSON、XML 等数据结构;

  • 支持将测试数据保存为测试用例,以后可以直接使用测试用例进行测试;

  • 支持批量测试 API,比如测试登录接口的多种情况并且返回实时测试数据;

  • 支持在测试过程中编写代码进行签名、加解密、生成随机数据等操作;

 

图注:在测试界面可以直接编写 JSON 数据

 

图注:一秒切换测试环境并且发起测试

2.3 Mock API

通过 Mock API,您可以事先编写好 API 的数据生成规则,由 Apikit 动态生成 API 的返回数据。开发人员通过访问 Mock API 来获得页面所需要的数据,完成对接工作。Mock API 支持根据不同的请求参数返回不同的 HTTP Status Code、Header、Body 等数据。您可以在一个 API 文档里创建多个 Mock API ,模拟前端发起的各种请求,方便对前端逻辑进行校验。当项目正式发布时,只需将 Mock API 的地址前缀替换为实际的访问地址即可。

 

图注:该 API 创建了多个 Mock API,前端可以传递不同的请求参数获取相应的返回结果,比如用户名为 jack liu 时返回登录成功,用户名为 percy 时返回登录失败或随机字符串。

2.4 自动化测试

在 Apikit 的自动化测试应用中,所有的测试用例都是以项目维度来进行管理,一个自动化测试项目可以从多个 API 文档项目中引用 API 信息来创建 API 测试用例。

 

 

图注:创建自动化测试用例

三、其他功能

3.1 强大的代码生成

Eolink 是一个强大的工具,可以轻松地生成各种语言的测试代码。首先,用户需要确定他们需要的特定语言,这可能包括 Java,Python,C++ 等。然后,通过 Eolink 的用户界面或命令行界面,输入相关的代码模块信息,包括模块的名称,需要的输入参数以及期望的输出结果。在填写完这些信息之后,只需点击 “生成” 按钮,Eolink 就会自动创建对应的测试代码。

3.2 数据导入导出

Eolink 提供一键导入已有 API 文档的功能,支持多种产品格式。常用于新项目创建后,需要对旧项目或旧软件内数据进行迁移的场景。

 

导出支持多种格式,只有你想不到。

 

四、绝对亮点

Eolink支持IDEA插件全代码注释自动生成API测试用例

4.1 插件安装

打开 IDEA 插件商店搜索:

  • Generate EolinkerDoc

  • Eolink ApiKit

 

4.2 插件配置

打开 IDEA setting,搜索 Eolink,配置4个参数:

  • Server:服务器地址(自己的 Eolink 控制台域名)。

  • SpaceKey:空间 Key。

  • ProjectHashKey:项目 hashKey,唯一标识一个独立的项目空间。

  • Token:登录用户身份标识,就是我们首次注册时分配的注册账号。

 

就可以通过 Eolink IDEA 插件一键生成 API 测试用例,并同步到 Eolink 控制台个人空间。这个插件要比我们手写 Swagger 注解,然后 SwaggerConfig 配置扫描 Controller 路径,运行后端服务之后,访问 swagger-ui.html 要方面的多,流程也简洁的多!

总结

整体体验下来,只能说 Eolink Apikit 非常强大,让API管理变得更简单。比如这个案例:用来设计 API,并且与 Gitlab 等代码仓库关联,实现从 Java 代码自动生成 API 文档。编写好新的 API 文档可以配合 Codegen 等工具生成代码模板,并且可以结合 Jenkins 形成自动化的流水线。简直是完美,效率高到飞起!

体验链接:

https://www.eolink.com/?utm_source=cpcs&utm_content=cpy16

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/kungfuboy17/article/details/130719615