DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
What's in store for DevOps in 2023? Hear from the experts in our "DZone 2023 Preview: DevOps Edition" on Fri, Jan 27!
Save your seat
  1. DZone
  2. Data Engineering
  3. Databases
  4. How to Verify API Responses in Katalon Studio

How to Verify API Responses in Katalon Studio

Learn how to verify API responses when performing API testing in Katalon Studio.

Oliver Howard user avatar by
Oliver Howard
·
Nov. 08, 18 · Tutorial
Like (3)
Save
Tweet
Share
13.52K Views

Join the DZone community and get the full member experience.

Join For Free

Verifying an API response is always a challenging task in API testing. Some testers may find it hard to understand the JSON/XML response format; while some others struggle with getting the value of a specific key to verify. It is even harder when the response is big enough with the complex data structure.

Starting from version 5.8.3, Katalon Studio has released a new feature that targets solving those issues with a simple step. In this tutorial, you will learn how to use this feature to verify API responses.

If you haven’t created any API tests using Katalon Studio, please follow this link (Create your first API test with Katalon Studio) to get familiar with the tool.

Verifying REST Responses in JSON Format

Assume that you have run an API, which returned a response in JSON format

Image title

The below steps will show you how to verify the response:

(1) Hover your cursor over the property you want to verify.

(2) You will see the information about JsonPath of the property you want to verify. Press the compose key “Ctrl + K” (on Windows) or “Cmd + K” (on Mac).

(3) A statement will be generated to verify the selected property.

Verifying SOAP Responses in XML Format

Assume that you have run an API, which returned a response in XML format

Image title

The steps below will help you verify the response:

(1) Hover your cursor over the element you want to verify.

(2) You will see the information about XmlPath of the element you want to verify. Press the compose key “Ctrl + K” (on Windows) or “Cmd + K” (on Mac).

(3) A statement will be generated to verify the selected element.

Run Tests With Generated Verification Statements

To run both types of request with the generated verification statements, you need to choose the option “Test Request and Verify”.

Image title

(1) First, select “Test Request and Verify” from the Run menu to send the request and verify the response.

(2) The verification results will be displayed in the Verification Log tab.

Congrats! You have successfully verified the response in both JSON and XML formats without having to know how to get JsonPath or XmlPath. We hope this tutorial will help remove the difficulty of verifying API responses.

API Katalon Studio

Published at DZone with permission of Oliver Howard. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • 5 Data Mesh Best Practices From 4 Data Leaders
  • Core Machine Learning Metrics
  • Load Balancing Pattern
  • Distributed Stateful Edge Platforms

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: