REST Assured 技术文档

1. 安装指南

1.1 Maven 依赖

要在 Maven 项目中使用 REST Assured，请在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>rest-assured</artifactId>
    <version>5.5.0</version>
    <scope>test</scope>
</dependency>

1.2 Gradle 依赖

如果你使用 Gradle，请在 build.gradle 文件中添加以下依赖：

testImplementation 'io.rest-assured:rest-assured:5.5.0'

1.3 其他构建工具

对于其他构建工具，请参考 Maven Central 上的最新版本。

2. 项目的使用说明

2.1 基本用法

REST Assured 提供了简单易用的 API，用于测试和验证 REST 服务。以下是一些基本示例：

2.1.1 GET 请求

get("/lotto").then().assertThat().body("lotto.lottoId", equalTo(5));

2.1.2 POST 请求

given().
    param("key1", "value1").
    param("key2", "value2").
when().
    post("/somewhere").
then().
    body(containsString("OK"));

2.1.3 认证

REST Assured 支持多种认证机制，例如基本认证：

given().auth().basic(username, password).when().get("/secured").then().statusCode(200);

2.2 响应处理

你可以轻松地获取和解析响应体：

2.2.1 JSON 响应

String json = get("/lotto").asString();
List<String> winnerIds = from(json).get("lotto.winners.winnerId");

2.2.2 XML 响应

String xml = post("/shopping").andReturn().body().asString();
Node category = from(xml).get("shopping.category[0]");

3. 项目API使用文档

3.1 常用API

3.1.1 given()

用于设置请求参数、头信息、认证等。

given().param("key", "value").when().get("/endpoint");

3.1.2 when()

用于指定 HTTP 方法和请求路径。

when().get("/endpoint");

3.1.3 then()

用于验证响应结果。

then().statusCode(200).body("key", equalTo("value"));

3.2 认证API

3.2.1 基本认证

given().auth().basic(username, password).when().get("/secured");

3.2.2 OAuth2

given().auth().oauth2(accessToken).when().get("/secured");

3.3 路径和参数

3.3.1 路径参数

given().pathParam("userId", "123").when().get("/users/{userId}");

3.3.2 查询参数

given().queryParam("q", "search").when().get("/search");

4. 项目安装方式

REST Assured 可以通过 Maven 或 Gradle 等构建工具进行安装。具体步骤如下：

4.1 Maven 安装

1. 在 pom.xml 文件中添加 REST Assured 依赖。
2. 运行 mvn clean install 命令进行安装。

4.2 Gradle 安装

1. 在 build.gradle 文件中添加 REST Assured 依赖。
2. 运行 gradle build 命令进行安装。

通过以上步骤，你可以在项目中成功安装并使用 REST Assured 进行 REST 服务的测试和验证。