REST Assured Tutorial 13 – Writing Response in a Text File

Last updated on December 12th, 2019 at 02:59 pm

As a part of End to End REST Assured Tutorial , in this post We will learn to write response to an external text file in Rest Assured.

You may required to save API response in to an external file like text or JSON etc file for future reference or as a proof. In this post, we will concentrate on saving response in a text file.

Rest Assured provides below methods to get response as:-

As byte array :- asByteArray()
As input stream :- asInputStream()
As string :- asString()

All above methods output can be used to write in to text file.

Rest Assured Code:-

package RestfulBooker.extractResponse;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import com.google.common.io.Files;

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

public class WriteResponseInTextFile {
	
	
	public static void main(String[] args) throws IOException {
		
		// 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();
		
		// Getting response as a string and writing in to a file
		String responseAsString = response.asString();
		// Converting in to byte array before writing
		byte[] responseAsStringByte = responseAsString.getBytes();
		// Creating a target file
		File targetFileForString = new File("src/main/resources/targetFileForString.txt");
		// Writing into files
		Files.write(responseAsStringByte, targetFileForString);
		
		
		// Getting response as input stream and writing in to a file
		InputStream responseAsInputStream = response.asInputStream();
		// Creating a byte array with number of bytes of input stream (available() method)
		byte[] responseAsInputStreamByte = new byte[responseAsInputStream.available()];
		// Reads number of bytes from the input stream and stores them into the byte array responseAsInputStreamByte.
		responseAsInputStream.read(responseAsInputStreamByte);
		// Creating a target file
		File targetFileForInputStream = new File("src/main/resources/targetFileForInputStream.txt");
		// Writing into files
		Files.write(responseAsInputStreamByte, targetFileForInputStream);
		
		// Directly getting a byte array
		byte[] responseAsByteArray = response.asByteArray();
		// Creating a target file
		File targetFileForByteArray = new File("src/main/resources/targetFileForByteArray.txt");
		// Writing into files
		Files.write(responseAsByteArray, targetFileForByteArray);
			    
			 
			   
			    
	}

}

package RestfulBooker.extractResponse;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import com.google.common.io.Files;

import io.restassured.RestAssured;

import io.restassured.http.ContentType;

import io.restassured.response.Response;

import io.restassured.specification.RequestSpecification;

public class WriteResponseInTextFile {

public static void main(String[] args) throws IOException {

// 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();

// Getting response as a string and writing in to a file

String responseAsString = response.asString();

// Converting in to byte array before writing

byte[] responseAsStringByte = responseAsString.getBytes();

// Creating a target file

File targetFileForString = new File("src/main/resources/targetFileForString.txt");

// Writing into files

Files.write(responseAsStringByte, targetFileForString);

// Getting response as input stream and writing in to a file

InputStream responseAsInputStream = response.asInputStream();

// Creating a byte array with number of bytes of input stream (available() method)

byte[] responseAsInputStreamByte = new byte[responseAsInputStream.available()];

// Reads number of bytes from the input stream and stores them into the byte array responseAsInputStreamByte.

responseAsInputStream.read(responseAsInputStreamByte);

// Creating a target file

File targetFileForInputStream = new File("src/main/resources/targetFileForInputStream.txt");

// Writing into files

Files.write(responseAsInputStreamByte, targetFileForInputStream);

// Directly getting a byte array

byte[] responseAsByteArray = response.asByteArray();

// Creating a target file

File targetFileForByteArray = new File("src/main/resources/targetFileForByteArray.txt");

// Writing into files

Files.write(responseAsByteArray, targetFileForByteArray);

}

Output:-

Refresh the project folder if you are using Eclipse. You should see three files as below:-

Open a file you should see it has stored response as below:-

You may be thinking which way is more optimal if you want to write in to a file. If you notice when we get response as String or inputStream , we must need to convert them to Byte array before writing in to a file. In third way we are directly getting Byte Array. So third way is more optimal.

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.

Table of Contents

Author: Amod Mahajan

My name is Amod Mahajan and I am an IT employee with 6+ years of experience in Software testing and staying in Bengaluru. My area of interest is Automation testing. I started from basics and went through so many selenium tutorials. Thanks to Mukesh Otwani as his tutorials are easy and cover basics to advance. I have habit of exploring concepts by deep diving. I used to make notes. I thought of sharing my knowledge through posts and now I am here. #KeepLearning #ShareLearning

REST Assured Tutorial 13 – Writing Response in a Text File

Author: Amod Mahajan

Like this:

Related

Leave a Reply Cancel reply

Subscribe to new posts to become automation expert