关于api设计:集成的-API-调试工具以前没听过

43次阅读

共计 1989 个字符,预计需要花费 5 分钟才能阅读完成。

在 Eolink ApiKit 之前,定义 API 用 Swagger,生成文档用 YAPI,前端自测用 Mock,接口测试用 Postman,性能测试用 JMeter。

有了 Eolink ApiKit 之 之后,Apikit = Postman + Swagger + Mock + JMeter,团队 API 治理老本大幅升高。

Apikit 是联合 API 设计、文档治理、自动化测试、监控、研发治理和团队合作的一站式 API 生产平台,从集体开发者到跨国企业用户,Apikit 帮忙寰球超过 50 万开发者和 10 万家企业更快、更好且更平安地开发和应用 API。

体验链接:
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy106

外围性能

1.1 API 文档

Eolink Apikit 反对弱小的 API 文档治理性能,包含多种创立文档的形式,导入导出,版本治理,查重等。

1.2 API 调试

当咱们创立好 API 文档之后,能够立即对该 API 进行测试,API 研发治理平台 提供了以下次要个性来帮忙测试人员疾速发动 API 测试:

  • 反对本地测试、局域网测试、在线测试等;
  • 反对一键切换测试环境,应用全局变量、减少额定申请参数、扭转申请地址等;
  • 反对间接在界面编辑 JSON、XML 申请数据,不再须要手写 JSON、XML 等数据结构;
  • 反对将测试数据保留为测试用例,当前能够间接应用测试用例进行测试;
  • 反对批量测试 API,比方测试登录接口的多种状况并且返回实时测试数据;
  • 反对在测试过程中编写代码进行签名、加解密、生成随机数据等操作;

1.3 Mock API

通过 Mock API,您能够当时编写好 API 的数据生成规定,由 Apikit 动静生成 API 的返回数据。开发人员通过拜访 Mock API 来取得页面所须要的数据,实现对接工作。Mock API 反对依据不同的申请参数返回不同的 HTTP Status Code、Header、Body 等数据。您能够在一个 API 文档里创立多个 Mock API,模仿前端发动的各种申请,不便对前端逻辑进行校验。当我的项目正式公布时,只需将 Mock API 的地址前缀替换为理论的拜访地址即可。

1.4 自动化测试

在 Apikit 的自动化测试利用中,所有的测试用例都是以我的项目维度来进行治理,一个自动化测试项目能够从多个 API 文档我的项目中援用 API 信息来创立 API 测试用例。

其余性能

2.1 弱小的代码生成

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

2.2 数据导入导出

Eolink 提供一键导入已有 API 文档的性能,反对多种产品格局。罕用于新我的项目创立后,须要对旧我的项目或旧软件内数据进行迁徙的场景。

导出反对多种格局,只有你想不到。

相对亮点

Eolink 反对 IDEA 插件全代码正文主动生成 API 测试用例

3.1 插件装置

关上 IDEA 插件商店搜寻:

  • Generate EolinkerDoc
  • Eolink ApiKit

3.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 造成自动化的流水线。几乎是完满,效率高到飞起!

Apikit 感觉翻新是比拟多的,把 Postman 里须要写脚本的性能都封装成了可视化界面,间接通过填写参数的形式去调试。

可视化界面其实会大大降低操作的门槛,写脚本的话至多须要会一些 js 语言,而像当初这样填参数的形式,不会脚本语言也能调试。

不过,如果你想要做一些简单的调试,它还是保留了脚本调试性能的。脚本调试反对第三方 js 类库,反对内部脚本和语言。

感兴趣的话 无妨去官网理解下,下载安装尝试,相对爽到爆 ……

正文完
 0