Skip to content

README.md

Latest commit

 

History

History
59 lines (43 loc) · 1.53 KB

README.md

File metadata and controls

59 lines (43 loc) · 1.53 KB
Raw

allure-rest-assured

REST Assured filter integration for Allure Java.

Use this module when your API tests use REST Assured and you want each request and response to be visible near the step that produced it in Allure Report.

Supported Versions

  • Allure Java 3.x requires Java 17 or newer.
  • This module targets REST Assured 6.x.
  • The current build validates against REST Assured 6.0.0.

Installation

Gradle:

dependencies {
    testImplementation(platform("io.qameta.allure:allure-bom:<allure-version>"))
    testImplementation("io.qameta.allure:allure-rest-assured")
}

Maven, with allure-bom imported in dependency management:

<dependency>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-rest-assured</artifactId>
    <scope>test</scope>
</dependency>

Setup

Register io.qameta.allure.restassured.AllureRestAssured as a REST Assured filter.

given()
        .filter(new AllureRestAssured())
        .when()
        .get("/orders");

You can customize sensitive data handling before registering the filter:

AllureRestAssured allure = new AllureRestAssured()
        .configureHttpExchange(exchange -> exchange
                .redactHeader("X-Api-Key")
                .redactCookie("SESSION")
                .setMaxBodySize(64 * 1024));

Report Output

  • Request method, URL, headers, cookies, form parameters, and body.
  • Response status, status text, headers, body, and timing.
  • Redacted REST Assured blacklisted headers and any custom redaction rules you configure.