在第 11 篇文章《互联网产品的测试策略应该如何设计?》中,我介绍过当今互联网产品的测试策略往往会采用菱形结构,即重量级 API 测试,轻量级 GUI 测试,轻量级单元测试,由此可见 API 测试在现今测试中的重要性不言而喻。
这篇文章是 API 自动化测试系列的第一篇文章,我会先为你打好 API 测试的基础。所以,我会先从 0 到 1 设计一个 API 测试用例,通过这个测试用例,你可以体会到最基本的 API 测试是如何进行的,并介绍几款常用的 API 测试工具。
API 测试的基本步骤
通常来讲,无论采用什么 API 测试工具,API 测试的基本步骤主要包括以下三大步骤:
-
准备测试数据(这是可选步骤,不一定所有 API 测试都需要这一步);
-
通过 API 测试工具,发起对被测 API 的 request;
-
验证返回结果的 response。
对 API 的测试往往是使用 API 测试工具,比如常见的命令行工具 cURL、图形界面工具 Postman 或者 SoapUI、API 性能测试的 JMeter 等。
为了让你更好地理解 API 测试具体是怎么做的,并掌握常见 API 测试工具的使用,我会以基于主流 Spring Boot 框架开发的简单 Restful API 为例,分别介绍如何使用 cURL 和 Postman 对其进行最基本的功能测试,目的是让你对 API 测试有一个基本的感性认识。
基于 Spring Boot 构建的 API
因为基于 Spring Boot 从 0 到 1 构建一个 API,并不是本文的重点,为了不影响你对文章主要内容的把握,我直接采用了一个预先开发好的 Account API 为例展开讲解。你可以从GitHub - SpectoLabs/spring-cloud-contract-blog下载完整的代码。
这个 Account API 的功能非常简单,就是基于你提供的 ID 值创建一个 Account 对象,并返回这个新创建 Account 对象。
比如,如果你的请求是“account/ID008”,那么返回的 response 就应该是“{“id”:“ID008”,“type”:“friends”,“email”:“robin@api.io”}”。
这个 Account API 的功能逻辑实现非常简单,图 1 和图 2 列出了主要的代码逻辑。
图 1 中,代码的第 21 行说明了 API 的 endpoint 以及对应的操作是 GET 方法,第 22 行明确说明了 GET 方法具体的业务逻辑是由 accountService.getById() 方法实现的。
图 1 RestController 的实现
图 2 中,代码的第 8 行实现了 accountService.getById() 方法,具体逻辑就是返回一个以传入 ID 为 ID 的 Account 对象。
图 2 具体业务逻辑的实现
我推荐使用 IntelliJ 打开这个下载的项目,然后直接启动其中的 account-service。启动成功后,account-service 会运行在本地机器的 8080 端口。启动成功后的界面如图 3 所示。
图 3 成功启动基于 Spring Boot 的 Account API