API Mocking with Katalon

When trying to do API testing we ofttimes observe ourselves in the land of “ what-ifs ” —what if the third-party services we rely on are down? What if the APIs we ask are still under building? The solution, a Mock API. While this is a powerful approach, to loose its full potential it is important to implement it correctly.

In this comprehensive usher, we provide you with the steps to assist you chief API Mocking in Katalon. From getting your own waiter get with the ‘ createAPIMockSession ’ keyword to publish custom-tailored responses via ‘ apiMockRule ’. Read on to discover more about how Katalon can help you with this journey.

What is a Mock API?

A Mock API or Mock imitates a real-world API by providing realistic responses to mate petition. They can be get to run on your local machine or on a network machine or on the public internet. & nbsp;

Responses from Mocks are mostly motionless and can be dynamic depending on the scenario. & nbsp;

Why do we need Mock API?

Most web covering or standalone middleware applications receive dependency with international APIs when integrating third-party services. Sometimes they may be unavailable while ontogenesis is in progress. Mock APIs are utilitarian when you have external dependence or APIs that are under development because they allow you to feign responses until the external/development API is alive. This grant QA teams to switch left and prepare and run examination automation betimes in the evolution life cycle.

In gain, sometimes, you may require an API to be available for consumer examination or demo before you commit to evolve it. & nbsp;

How Katalon uses Mock APIs?

All it demand is a Katalon Studio plugin which let you to mock your APIs and help you significantly leave displacement. There are three main keywords that permit you to bemock APIs:

createAPIMockSession & nbsp;– This keyword starts the Mock server with all the normal hosted in it before the start of your tests/suites with the Mock.

It will create an API Mock on the specified host/domain and port via arguments. Below are the disceptation and their respective conditions.
 

host– Optional – Specify the host/domain as string. Usually localhost, IP reference of the host, or domain name. Default value is `` localhost ''.

httpPort– Optional – Specify the port your API Mock will listen to. The nonpayment value is 8080.

httpsPort– Optional – Specify the https port your API Mock will heed to. The default value is 443.
 

Here are some examples: createAPIMockServer (`` localhost '', 8080); createAPIMockServer (`` 127.0.0.1 '', 443); and createAPIMockServer (`` localhost '', 8080, 443).

apiMockRule– This keyword allows you to create specific API rules for which specific responses must be regress. For example, you could have a Mock API that sends responses for GET requests with specific URL path, message body, headers, authentication, or query parameters.

Below are the parameters that are used to create such rules (all these parameters are optional so a rule can be created without set any point, and in such case default values will be used):

httpMethod – Optional – parameter used to determine requests that match http methods GET, POST, PUT, and DELETE. If no method is specified, then a common reply will be sent for any method. You may also create a condition by specify “ Any ” if the response will be applicable for any type of transaction.

For autonomous testing across multiple user personas, check out SUSATest — it explores your app like 10 different real users.

urlPath – Optional – if this parameter is not specified so the horde cater during the create mock session will be used as URL/endpoint for the mock, or else condition URL path such as `` /getNames '' or `` /deleteCity '' will append to the host to form the URL/endpoint.

basicAuthUsername & nbsp;– Optional – do not specify if you do n't have basic auth for the request.

basicAuthPassword & nbsp;– Optional – do not specify if you do n't have basic auth for the request.

requestQueryParams– Optional – the URL query parameter condition that will be part of the request URL.

requestHeaders- Optional – the header conditions for the request.

requestBody– Optional – this is the body of the request as regex twine. This is a design that will be matched.

requestCookies– Optional – biscuit conditions on the request to direct response.

responseStatus– Optional – the response status code that will be post back to the client.

responseHeaders– Optional – response headers to be sent.

responseBody & nbsp;– Optional – response body that must be sent for the asking condition specified above.

stopAPIMockSession & nbsp;– This keyword stops the Mock server that was part before at the end of your test run.

Below are the steps to get depart with API Mocking:

Step 1

Download the late Mock API jar variation from the & nbsp;

Step 2

Place the Mock API jar into the plugins folder of the Katalon Studio undertaking and so restart Katalon Studio. You should see the jar file in your plugins folder after restarting Katalon Studio. Also, on the Event Log tab you should be capable to see the API plugin loading successfully.

You are now ready to use Mock APIs.

Step 3

Create a Katalon Studio Test Case for the API under test.

Step 4

Use Add to add Custom Keyword ‘ createAPIMockSession ’ using parameters for host, port, and httpsPort. You can also leave these tilt blank so default arguments for the same will be picked up.

Step 5

Now you can add multiple API Mock normal, as shown below.

Step 6

Create an API to meet the above Mock rule in the Object Repository. & nbsp;(You may also make substantiation rules for the API optionally.)

Step 7

Call the API created above from the API Test Case (shew below) and then add the final keyword ‘ stopAPIMockSession ’.

Step 8

Run the Test Case which should produce results like below:

Wrapping up!

Serving as an essential platform for developers and QA teams likewise, Katalon Platform facilitates API Mocking. These features allow for a high degree of customization and flexibility, thereby furnish a contributive environment for early-stage examination and seamless integration. The capabilities of Katalon Studio undoubtedly simplify the otherwise intricate process of API Mocking, thus quicken the development life rhythm and enhancing software quality. & nbsp;

We trust you enjoyed this guide, stop tuned for more!