REST API & WebServices Testing with Katalon Studio

Introduction

API Testing is one of the hottest trends of Software Testing this year and still keeps growing up till now. Instead of being handled solely by developers, testing API is presently a common practice among many outsourcing teams. This short article will give a comprehensive tutorial on how to perform REST API & WebServices Testing with Katalon Studio.

How to perform REST API & WebServices Testing with Katalon Studio?

Install and set up Katalon Studio

If you have not set up Katalon Studio yet, please refer to this guide for further instruction: https://www.katalon.com/resources-center/tutorials/web/get-started/install-setup-katalon-studio/.

Create a new project and set up API automation test

Step 1: Create a new project

Go to File → New → Project. Enter a project name and its location to start a new project.

Once the project is confirmed to be created, you will see a folder structure in the Test Explorer panel. This folder system serves to keep all test resources. It is also where you start your first API test.

Step 2: Create a new API test

Before creating your first API test, let’s have a look at the format used to set up a testing project.

• Object Repository: Object Repository is a place which stores all Web service endpoints along with all information of request method, URL, header, content, and authentication. Web service test objects in Object Repository are integrated by a folder system for better management.
• Test Cases: Test Cases stores all test scenarios and is categorized by a folder system. Each test case includes a few steps that illustrate a test scenario. You can execute a test case individually with a specified execution profile.
• Test Suites: Test Suites is where all test suites are stored. A test suite is a collection of test cases that verify a specific target. Test cases at ‘test suite’ level can be executed with a data-driven approach. Test reports are also generated at ‘test suite’ level.
• Test Suite Collection: Test Suite Collection is a collection of Test Suites that verifies a larger target.Test Suites at ‘Test Suite’ Collection level has specific Test environments specified.

Step 3: Create a new RESTful endpoint at Object Repository

Object Repository → New → Web Service Request

Katalon Studio stores Web service endpoints for testing at Object Repository, which is similar to Test Object in UI Test. At the “Create New Web Service Request” dialog, you can either choose to create a RESTful or a SOAP request.

“Request type” is a required field. You need to specify it at this very step. In contrast, “URL” is not required. You can set this value later in the next step.

Click “OK.” Then we are ready to input more details to the first RESTful test.

There are some important concepts needed to specify when testing a RESTful request:

1) Request method: You can choose one of these following methods for your first request test: GET, POST, PUT, or DELETE. The method needs to match with the URL to have a valid request. For instance, let’s assume that your first test is a public API from Jira Cloud version. In this case, you should select the GET method to receive information on an existing ticket using its ID.

2) Request URL: Along with the request method, “request URL” tells the web server which API is utilized under test. Any mismatch between method and URL will lead to invalid request exception at runtime or wrong data response.

3) Authorization: Authorization is an essential part of an API. It is used to get the correct data under permission (unless the data is public). Katalon Studio supports common authentication methods:

Basic: The basic method requires username and password. Don’t forget to click ‘Update to HTTP Header’ so that the authentication can be applied to ‘HTTP Header’.

4) Verification: Verification is where you define assertion to ensure the response will contain the expected information.

The verification tab of a request is similar to the Script tab of a test case. In other words, you can write custom scripts with built-in keywords or Groovy/Java scripts to verify the response data. Besides built-in keywords, Katalon Studio also supports built-in snippets, which help you generate assertions with a single click. This feature is useful for testers who might find it difficult to deal with parsing or to assert with JSON data format.

The right panel of the request consists of the responses automatically displayed in a nice format, and the verification results in Verification Log. To include verification script when sending the request, you need to choose the ‘Test Request and Verify’ option from the execution button.

The Verification script gives you quick feedback of the request status rather than an actual test. You can add more assertions at the ‘test case’ level in the next step.

5) Variables: Variables make API testing more robust and dynamic with the data-driven approach. In Katalon Studio, every part of the request can be parameterized. In other words, dynamic data can be used for: URL, authentication, HTTP Header, and HTTP Body to maximize the capability of data-driven testing. Let’s have a look at this example:

6) Formatter: The response will be automatically displayed in a neat format: JSON, XML, HTML, and JavaScript. This gives you a quick view of the response status.

Step 4: Create a new test case with an existing request

While the request at Object Repository is helpful for fast testing, you can add the request verification at test case level for better managing and reporting.

Step 5: Add an existing request to a test case

A request can be inserted to a test case with Web service built-in keywords. There are many keywords that can be used to send the request, to verify the response, and to make the request as part of a bigger testing flow.

Following test case illustrates how we can call the request with verification steps from a test case:

The test case can be executed as a normal test case in Katalon Studio. Each verification step can be viewed from the log.

Step 6: Add a test case to the test suite

A test case can be added to a test suite via either the drag-and-drop feature or the “Add test case” tool. Once the test case is added to the test suite, we can execute the entire test suite with the Run button (without selecting the browser as in UI testing)

Next steps

Now you have finished creating your first test. To create tests for a real project with practical solutions, we will need to create more tests with more techniques:

• Parameterize your tests
• Apply data-driven approach
• Create custom keywords/packages
• Call tests and reuse code
• Include error handling
• View test reports after test suite execution

Katalon new features

Katalon Studio has recently had a new monthly release to support BDD Cucumber which is a testing approach in which test cases are written in natural languages to improve communication between technical staff and business stakeholders. BDD Cucumber also helps create test scenarios for the acceptance test phase.

The above-mentioned instruction is all of what you need to achieve your very first API Testing in Katalon Studio. However, if you want to accomplish the best outcomes as well as could save lots of your testing time, you will need much more learning effort in API Testing. For example, we need to have appropriate implementations of techniques and awareness of whether an API should be tested automatically or manually. And this tool will definitely help you improve product quality exceptionally.