REST Assured Tutorial 53 – How to create ResponseSpecification using ResponseSpecBuilder
Introduction
As a part of End to End REST Assured Tutorial, in this post, we will learn to create a ResponseSpecification using ResponseSpecBuilder class in Rest Assured.
Prerequisite
I have used below dependency of Rest Assured library for this post:-
|
1 2 3 4 5 6 7 |
<!-- https://mvnrepository.com/artifact/io.rest-assured/rest-assured --> <dependency> <groupId>io.rest-assured</groupId> <artifactId>rest-assured</artifactId> <version>4.3.1</version> <scope>test</scope> </dependency> |
You should go through below posts once to understand this post better:-
Interface RequestSpecification – How The Request Will Look Like
ResponseSpecification – Specify How The Expected Response Must Look Like
What is ResponseSpecBuilder?
ResponseSpecBuilder class provides you a builder to create a ResponseSpecification. This class has self explanatory methods like expectStatusCode(), expectHeaders() etc compare to methods of ResponseSpecification interface.
We can create a ResponseSpecification using ResponseSpecBuilder as below:-
|
1 2 3 4 5 6 7 |
// Create a ResponseSpecification using ResponseSpecBuilder ResponseSpecBuilder responseSpecBuilder = new ResponseSpecBuilder(); responseSpecBuilder.expectStatusCode(200); responseSpecBuilder.expectStatusLine("HTTP/1.1 200 OK"); responseSpecBuilder.expectContentType(ContentType.JSON); responseSpecBuilder.expectResponseTime(Matchers.lessThan(5000L)); ResponseSpecification responseSpecification = responseSpecBuilder.build(); |
Or instead of calling ResponseSpecBuilder reference multiple times, we can use the builder pattern as below:-
|
1 2 3 4 5 6 7 |
// Create a ResponseSpecification using ResponseSpecBuilder responseSpecification = new ResponseSpecBuilder() .expectStatusCode(200) .expectStatusLine("HTTP/1.1 200 OK") .expectContentType(ContentType.JSON) .expectResponseTime(Matchers.lessThan(5000L)) .build(); |
Example Program
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
package ResponseSpecificationExample; import org.hamcrest.Matchers; import org.testng.annotations.BeforeClass; import org.testng.annotations.Test; import io.restassured.RestAssured; import io.restassured.builder.ResponseSpecBuilder; import io.restassured.http.ContentType; import io.restassured.specification.ResponseSpecification; public class ResponseSpecBuilderExampleBuilderPattern { ResponseSpecification responseSpecification = null; @BeforeClass public void setupResponseSpecification() { // Create a ResponseSpecification using ResponseSpecBuilder responseSpecification = new ResponseSpecBuilder() .expectStatusCode(200) .expectStatusLine("HTTP/1.1 200 OK") .expectContentType(ContentType.JSON) .expectResponseTime(Matchers.lessThan(5000L)) .build(); } @Test public void getAllBookings() { // Given RestAssured .given() .baseUri("https://restful-booker.herokuapp.com") // When .when() .get("/booking") // Then .then() // Just pass ResponseSpecification as below .spec(responseSpecification) // To verify booking count .body("size()", Matchers.greaterThan(5)); } @Test public void getBookingDetailsWithInvalidFirstName() { // Given RestAssured .given() .baseUri("https://restful-booker.herokuapp.com") // When .when() .get("/booking?firstname=jim") // Then .then() .spec(responseSpecification) // To verify booking count .body("size()", Matchers.equalTo(0)); } } |
You can download/clone the above sample project from here.
You can subscribe to my YouTube channel RetargetCommon to learn from video tutorials.
If you have any doubt, feel free to comment below.
If you like my posts, please like, comment, share and subscribe.
#ThanksForReading
#HappyLearning
Find all Selenium related posts here, all API manual and automation related posts here, and find frequently asked Java Programs here.
Many other topics you can navigate through the menu.
responseSpecBuilder.expectResponseTime(Matchers.lessThan(1000L));
here what is the meaning of “L”
Long data type.