web-services-automation-using-rest-assured: A Java repository from venkywarriors

How to resolve javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException:

RestAssured.useRelaxedHTTPSValidation(); //disable usual https verification aswell

Basics

Example

rest-assured offical

Sample programs : https://github.com/rest-assured/rest-assured/tree/master/examples/rest-assured-itest-java/src/test/java/io/restassured/itest/java

🎯 GET Request Method using Rest Assured

import io.restassured.RestAssured;
import io.restassured.http.Method;
import io.restassured.response.Response;
import io.restassured.specification.RequestSpecification;
 
public class RestAssuredAPITest {
 
 @Test
public void GetBooksDetails() { 
	// Specify the base URL to the RESTful web service 
	RestAssured.baseURI = "https://demoqa.com/BookStore/v1/Books"; 
	RequestSpecification httpRequest = RestAssured.given();

	Response response = httpRequest.request(Method.GET, "/Hyderabad");
  //Passing the resource details by Query Parameters
  Response res = httpRequest.queryParam("ISBN","9781449325862").get("/Book");

	System.out.println("Status received => " + response.getStatusLine()); 
	System.out.println("Response=>" + response.prettyPrint());
  System.out.println("Server value: " + response.header("Server"));

  int statusCode = response.getStatusCode();

  // Assert that correct status code is returned.
  Assert.assertEquals(statusCode /*actual value*/, 200 /*expected value*/, "Correct status code returned");

	// Retrieve the body of the Response
	ResponseBody body = response.getBody();

	// By using the ResponseBody.asString() method, we can convert the  body
	String bodyAsString = body.asString();
	Assert.assertEquals(bodyAsString.contains("Hyderabad") /*Expected value*/, true /*Actual Value*/, "Response body contains Hyderabad");

  // Get all the headers and then iterate over allHeaders to print each header 
   Headers allHeaders = response.headers(); 
   // Iterate over all the Headers 
   for(Header header : allHeaders) { 
     System.out.println("Key: " + header.getName() + " Value: " + header.getValue()); 
   }

  // First get the JsonPath object instance from the Response interface
	JsonPath jsonPathEvaluator = response.jsonPath();

	// Then simply query the JsonPath object to get a String value of the node
	String city = jsonPathEvaluator.get("City");

	// Validate the response
	Assert.assertEquals(city, "Hyderabad", "Correct city name received in the Response");
}
}

🎯 POST Request Method using Rest Assured

    RestAssured.baseURI ="https://demoqa.com/Account/v1"; 
    RequestSpecification request = RestAssured.given(); 
    JSONObject requestParams = new JSONObject();
    requestParams.put("userName", "test_rest");
    requestParams.put("password", "Testrest@123"); 
    request.body(requestParams.toJSONString());
    Response response = request.put("/User"); 
    ResponseBody body = response.getBody();
    System.out.println(response.getStatusLine());
    System.out.println(body.asString());

🎯 Serialization and Deserialization using Rest Assured

Make sure you have the Jackson library in your project

import com.fasterxml.jackson.databind.ObjectMapper;

public class SerializationExample {

    public static void main(String[] args) {
        // Create an instance of the class to serialize
        Person person = new Person();
        person.setName("John");
        person.setAge(30);

        // Create an ObjectMapper
        ObjectMapper objectMapper = new ObjectMapper();

        try {
            // Serialize the object to JSON string
            String jsonString = objectMapper.writeWithDefaultPrettyPrinter().writeValueAsString(person);

            // Print the JSON string
            System.out.println(jsonString);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

🎯 Deserialization Using ObjectMapper

import com.fasterxml.jackson.databind.ObjectMapper;

public class DeserializationExample {

    public static void main(String[] args) {
        // JSON string to deserialize
        String jsonString = "{\"name\":\"John\",\"age\":30}";

        // Create an ObjectMapper
        ObjectMapper objectMapper = new ObjectMapper();

        try {
            // Deserialize the JSON string into a Person object
            Person person = objectMapper.readValue(jsonString, Person.class);

            // Use the deserialized object
            System.out.println("Name: " + person.getName());
            System.out.println("Age: " + person.getAge());

            Map<string,object> personmap = objectMapper.readValue(jsonString, Map.class);
            System.out.println("Name: " + person.get("Name"));
            System.out.println("Age: " + person.get("Age"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

🎯 Serialization and Deserialization Using Apache Juneau

import org.apache.juneau.json.JsonSerializer;
import org.apache.juneau.json.JsonParser;

public class JuneauSerializationAndDeserializationExample {

    public static void main(String[] args) {
        // Create an instance of the class to serialize
        Person person = new Person();
        person.setName("John");
        person.setAge(30);

        // Serialize the object to JSON string
        String jsonString = JsonSerializer.DEFAULT_READABLE.serialize(person);

        // Print the JSON string
        System.out.println("Serialized JSON: " + jsonString);

        // Deserialize the JSON string back to a Person object
        Person deserializedPerson = JsonParser.DEFAULT.parse(jsonString, Person.class);

        // Use the deserialized object
        System.out.println("Deserialized Person: " + deserializedPerson.getName() + ", " + deserializedPerson.getAge());
    }
}

🎯 Extract and print the response time in seconds

import io.restassured.RestAssured;
import io.restassured.response.Response;

public class ApiRequestExample {

    public static void main(String[] args) {
        // Replace with your API endpoint
        String apiUrl = "https://api.example.com/data";

        // Make API request and measure response time
        Response response = RestAssured.get(apiUrl);

        // Extract and print the response time in seconds
        long responseTimeInMillis = response.time();
        double responseTimeInSeconds = responseTimeInMillis / 1000.0;
        System.out.println("API Response Time: " + responseTimeInSeconds + " seconds");

        // Process the API response as needed
        System.out.println("API Response: " + response.getBody().asString());
    }
}

🎯 Authentication

package org.example;
import org.testng.annotations.Test;

import io.restassured.RestAssured;
import io.restassured.response.Response;
import io.restassured.response.ResponseBody;
import io.restassured.specification.RequestSpecification;

public class BasicAuth {

    @Test
    public void getData() {
	//basic authentication scheme
       RequestSpecification httpRequest = RestAssured.given().auth().basic("postman", "password");

  	//Using the preemptive directive of basic auth to send credentials to the server
        RequestSpecification httpRequest = RestAssured.given().auth().preemptive().basic("postman", "password");
	//Digest Authentication
        RequestSpecification httpRequest = RestAssured.given().auth().digest().("postman", "password");
	//Form Authentication
	RequestSpecification httpRequest = RestAssured.given().auth().form().("postman", "password");
	//OAuth 2.0
	given().auth().oauth2("Access token").get("your end point URL")

        Response res = httpRequest.get("https://postman-echo.com/basic-auth");
       
       ResponseBody body = res.body();
       //Converting the response body to string
       String rbdy = body.asString();
       System.out.println("Data from the GET API- "+rbdy);
    }
}

🎯 DeSerialize JSON Array to List of String using JSONPath

@Test
public void JsonPathUsage() throws MalformedURLException
{
	RestAssured.baseURI = "https://restapi.demoqa.com/utilities/books/getallbooks";
	RequestSpecification httpRequest = RestAssured.given();
	Response response = httpRequest.get("");

	// First get the JsonPath object instance from the Response interface
	JsonPath jsonPathEvaluator = response.jsonPath();

	// Read all the books as a List of String. Each item in the list
	// represent a book node in the REST service Response
	List<String> allBooks = jsonPathEvaluator.getList("books.title");

	// Iterate over the list and print individual book item
	for(String book : allBooks)
	{
		System.out.println("Book: " + book);
	}
}

🎯 To upload a file using RestAssured

import io.restassured.RestAssured;
import io.restassured.http.ContentType;
import io.restassured.response.Response;
import java.io.File;

public class FileUploadExample {

    public static void main(String[] args) {
        // Replace with your API endpoint
        String apiUrl = "https://api.example.com/upload";

        // Replace with the path to the file you want to upload
        String filePath = "/path/to/your/file.txt";

        // Set up RestAssured base URI
        RestAssured.baseURI = apiUrl;

        // Perform the file upload
        Response response = RestAssured.given()
                .multiPart(new File(filePath))
                .when()
                .post();

        // Print the response
        System.out.println("Response Code: " + response.getStatusCode());
        System.out.println("Response Body: " + response.getBody().asString());
    }
}

🎯 Get an XML response using RestAssured

import io.restassured.RestAssured;
import io.restassured.http.ContentType;
import io.restassured.response.Response;

public class XmlResponseExample {

    public static void main(String[] args) {
        // Replace with your API endpoint
        String apiUrl = "https://api.example.com/data";

        // Set up RestAssured base URI
        RestAssured.baseURI = apiUrl;

        // Perform the GET request and expect XML response
        Response response = RestAssured.given()
                .header("Accept", ContentType.XML.getAcceptHeader())
                .when()
                .get();

        // Print the XML response
        System.out.println("Response Code: " + response.getStatusCode());
        System.out.println("XML Response Body: " + response.getBody().asString());
    }
}

🎯 RestAssured for a SOAP request

Click to view

@Test
public void postMethod() throws Exception {
        FileInputStream fileInputStream = new FileInputStream(new File(".\\SOAPRequest\\SoapRequestFile.xml"));
         RestAssured.baseURI="http://currencyconverter.kowabunga.net";
         
         Response response=given()
                .header("Content-Type", "text/xml")
                .and()
                .body(IOUtils.toString(fileInputStream,"UTF-8"))
         .when()
            .post("/converter.asmx")
         .then()
                .statusCode(200)
                .and()
                .log().all()
                .extract().response();
         
        XmlPath jsXpath= new XmlPath(response.asString());//Converting string into xml path to assert
        String rate=jsXpath.getString("GetConversionRateResult");
        System.out.println("rate returned is: " +  rate);

venkywarriors/web-services-automation-using-rest-assured