REST Assured Tutorial 9 – Let’s Write First POST Request in REST Assured
As a part of End to End REST Assured Tutorial , in this post We will write first POST request in REST assured.
I will strongly recommended you to learn basics of API testing from here.
To learn what is POST request and how can you hit a POST request in Postman tool, must refer this post.
We will automate a POST request named “GetAuth” from Restful Booker. We will perform some validations like status code as well.
GetAuth API takes body as below where you need to pass username and password. If you pass credentials correctly, you will get token else error message.
|
1 2 3 4 |
{ "username" : "admin", "password" : "password123" } |
Let’s start writing a POST request in REST Assured using both BDD and Non-BDD style. We will see multiple ways of writing same test as well.
Passing body to POST request:-
We know that we need to pass a payload ( JSON or XML) to POST request. REST Assured makes it very handy to pass body to request. We can pass body as a String or a JSON file or a XML file or a Java Object or a byte array. We will see all ways in upcoming posts but as of now we will pass body as a String.
Non-BDD Style:-
|
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 |
package RestfulBooker.postExamples; import org.hamcrest.Matchers; import io.restassured.RestAssured; import io.restassured.http.ContentType; import io.restassured.response.Response; import io.restassured.response.ValidatableResponse; import io.restassured.specification.RequestSpecification; public class NonBDDStylePostRequest { public static void main(String[] args) { // There is no need to add escape character manually. Just paste string within double // quotes. It will automatically add escape sequence as required. String jsonString = "{\"username\" : \"admin\",\"password\" : \"password123\"}"; // Create a request specification RequestSpecification request= RestAssured.given(); // Setting content type to specify format in which request payload will be sent. // ContentType is an ENUM. request.contentType(ContentType.JSON); //Adding URI request.baseUri("https://restful-booker.herokuapp.com/auth"); // Adding body as string request.body(jsonString); // Calling POST method on URI. After hitting we get Response Response response = request.post(); // Printing Response as string System.out.println(response.asString()); // Get Validatable response to perform validation ValidatableResponse validatableResponse = response.then(); // Validate status code as 200 validatableResponse.statusCode(200); // Validate token field is null // SInce response is one to one mapping so passing key name will give you value. // Below method validates that value of token is not null. validatableResponse.body("token", Matchers.notNullValue()); // Validate token length is 15 validatableResponse.body("token.length()", Matchers.is(15)); // Validate token is an alphanumeric value validatableResponse.body("token", Matchers.matchesRegex("^[a-z0-9]+$")); } } |
BDD Style:-
|
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 |
package RestfulBooker.postExamples; import org.hamcrest.Matchers; import io.restassured.RestAssured; import io.restassured.http.ContentType; public class BDDStylePostRequest { public static void main(String[] args) { // There is no need to add escape character manually. Just paste string within double // quotes. It will automatically add escape sequence as required. String jsonString = "{\"username\" : \"admin\",\"password\" : \"password123\"}"; //GIVEN RestAssured .given() .baseUri("https://restful-booker.herokuapp.com/auth") .contentType(ContentType.JSON) .body(jsonString) // WHEN .when() .post() // THEN .then() .assertThat() .statusCode(200) .body("token", Matchers.notNullValue()) .body("token.length()", Matchers.is(15)) .body("token", Matchers.matchesRegex("^[a-z0-9]+$")); } } |
You can clone/download example repo here.
If you have any doubt, feel free to comment below.
If you like my posts, please like, comment, share and subscribe.
#ThanksForReading
#HappyLearning
You can find all Selenium related post here.
You can find all API manual and automation related posts here.
You can find frequently asked Java Programs here.
Hi Amod,One request can you please add some feature like if i am reading tutorial number 1 then at the bottom of tutorial tutorial number 2 link should present .
HI Amod Mahajan
Could you please share valid credentials for auth token
Below credentails are not working
“username” : “admin”,
“password” : “password123”,
Waiting for your quick reply
Thank you in advance
Auth Authentication user and password is incorrect could you please share valid once
Hi if we use triple quotation “”” json format””” no need to escape try this.
Thanks for creating the tutorial in both style which made the concept very clear
Post may return 200 also.
hi
for post request , why are you validating with status 200? why not 201?
Hey, because example APIs returns 200 on successful post request. It is completely dependent on developers what status code they return. If they return 201, we need to assert as 201.
Depending up on requirements you can use 200 or 201