how a api response should be code example

Example 1: what do you test in response api

Basicall we are checking response body
to verify if request matches with response.
In the response we are verifying
(body, status code, header, response time,
 test structure of json against the given jsonSchema)
 
 
If file not under resources: 
File schemaFile = new File("src/test/resources/postSuccessResponseSchema.json");

     given()
        .spec(adminReqSpec)
        .contentType(ContentType.JSON)
        .body(abcUtil.getRandomHeroPOJO_Payload()).
     when()
        .post("/HEROS").
     then()
        .body(matchesJsonSchema( schemaFile )  ) 
        
        
If schema file under resources:
  given()
      .spec(adminReqSpec)
      .queryParam("nameContains","a")
      .queryParam("gender","Female").
  when()
      .get("/abc/search").
 then()
 	  .time( lessThan(2000L));	
      .body(matchesJsonSchemaInClasspath("searchSpartanSchema.json") )

Example 2: response api

RESPONSE :(STATUS CODE,PAYLOAD(body),HEADER,COOKIE,
           TIME(spent to get response))

1-Status Code:
   2xx - Success
   4xx - Client Error
   5xx - Server Error

2-Payload(Body) : 
The actual resource we got from the server.
Content type can be : plain text, json, xml, html, json etc.

3- Metadata about response to provide more information

4- Cookie

5- Time for getting spended time for the response

Tags:

Misc Example