手把手教你写接口自动化测试(JAVA代码版)-CFANZ编程社区

手把手教你写接口自动化测试(JAVA代码版)

在这篇文章中，我们将通过分步指南教你如何使用 JAVA 进行接口自动化测试。我们会从环境准备开始，按照顺序深入每个模块，直到完成一套完整的接口测试方案。接下来就跟我一起动手吧。

环境准备

在开始之前，我们需要确保你的开发环境是完善的。首先，请安装以下前置依赖：

Java Development Kit (JDK)
Maven
Postman（可选，用于接口测试调试）

前置依赖安装

下面的命令可以直接在终端中执行：

# 安装 JDK 
sudo apt install openjdk-11-jdk

# 安装 Maven
sudo apt install maven

环境搭建时间规划

gantt
    title 环境搭建时间规划
    dateFormat  YYYY-MM-DD
    section 安装前置依赖
    JDK                :a1, 2023-10-01, 1d
    Maven              :a2, 2023-10-02, 1d

分步指南

接下来，我们将设置基本的项目结构和必要的配置，准备好进行接口的自动化测试。

基础配置

创建一个新的 Maven 项目：

mvn archetype:generate -DgroupId=com.example -DartifactId=ApiTest -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

导入测试框架依赖。在项目的 pom.xml 中，加入以下代码：

<dependencies>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <version>5.7.0</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>io.rest-assured</groupId>
        <artifactId>rest-assured</artifactId>
        <version>4.3.0</version>
    </dependency>
</dependencies>

运行 mvn clean install 来安装依赖。

高级步骤

<details> <summary>点击展开显示高级步骤</summary>

创建一个名为 ApiTests.java 的测试类，在 src/test/java/com/example/ 路径下：

package com.example;

import io.restassured.RestAssured;
import org.junit.jupiter.api.Test;

public class ApiTests {
    @Test
    public void testGetEndpoint() {
        RestAssured.given()
            .when()
            .get("
            .then()
            .statusCode(200); // 验证响应状态码
    }
}

</details>

可以看到，我们已经完成了基础配置，现在我们要进行更详细的配置详解。

配置详解

我们将使用一个模板来规范参数和请求结构，同样重要的是，了解各个参数的作用。

参数	类型	描述
url	String	接口请求的 URL
method	String	HTTP 方法 (GET/POST)
requestBody	String	请求体 (适用于 POST)
headers	Map<String, String>	请求头信息

验证测试

在这部分，我们要确保我们的接口测试有效，包含性能验证和相关代码。

性能验证

@Test
public void testGetPerformance() {
    long startTime = System.currentTimeMillis();

    RestAssured.given()
        .when()
        .get("
        .then()
        .statusCode(200);

    long endTime = System.currentTimeMillis();
    System.out.println("请求时间: " + (endTime - startTime) + " 毫秒");
}

测试路径

journey
    title 接口测试测试路径
    section 测试请求
      user->REST API: 发送 GET 请求
      REST API->user: 返回响应

排错指南

在接口测试过程中，难免会遇到一些常见的错误。下面是一些可能会碰到的错误及其日志信息。

常见错误

404 Not Found
500 Internal Server Error

以下是样本的错误日志：

{
    "status": 404,
    "error": "Not Found",
    "message": "The requested resource was not found"
}

扩展应用

如果你希望将这个项目整合进更大的系统，使用 Terraform 便是一个不错的选择。

集成方案

provider "aws" {
  region = "us-east-1"
}

resource "aws_lambda_function" "api_test" {
  function_name = "ApiTestFunction"
  runtime = "java11"
  handler = "com.example.ApiTests::handleRequest"
}

组件依赖

erDiagram
    API_TEST ||--o{ AWS_LAMBDA : deploys
    AWS_LAMBDA ||--o{ API_GATEWAY : triggers