API Automation in Karate DSL

 Karate DSL is a powerful open-source framework for API testing that combines API automation, data-driven testing, and BDD (Behavior-Driven Development) style syntax in one package. Unlike tools like RestAssured or Postman, Karate requires no Java coding to write tests—it's written in a readable .feature file format using Gherkin.


🚀 Why Use Karate for API Automation?

✅ BDD-style syntax (readable and maintainable)


✅ Built-in HTTP client (no need for external libraries like RestAssured)


✅ Supports JSON, XML, SOAP, file uploads, and GraphQL


✅ Supports data-driven and parallel testing


✅ Easy integration with CI/CD pipelines


📦 Basic Project Setup

1. Maven Dependency

Add this to your pom.xml:


xml

Copy

Edit

<dependency>

  <groupId>com.intuit.karate</groupId>

  <artifactId>karate-junit5</artifactId>

  <version>1.4.1</version> <!-- Use latest -->

  <scope>test</scope>

</dependency>

🧪 Basic API Test Example

File: src/test/java/examples/api/getUser.feature

gherkin

Copy

Edit

Feature: Get user details


Scenario: Get user by ID

  Given url 'https://jsonplaceholder.typicode.com/users/1'

  When method GET

  Then status 200

  And match response.name == 'Leanne Graham'

🔁 POST Request with JSON Payload

gherkin

Copy

Edit

Feature: Create a new user


Scenario: Create user

  Given url 'https://jsonplaceholder.typicode.com/users'

  And request { name: 'John Doe', email: 'john@example.com' }

  When method POST

  Then status 201

  And match response.name == 'John Doe'

📂 Data-Driven Testing with Examples

gherkin

Copy

Edit

Feature: Login API test


Scenario Outline: Login with multiple users

  Given url 'https://example.com/api/login'

  And request { username: '<user>', password: '<pass>' }

  When method POST

  Then status 200


Examples:

  | user      | pass       |

  | user1     | pass123    |

  | user2     | pass456    |

🛠 Running Tests

With Maven:

bash

Copy

Edit

mvn test -Dtest=examples.api.getUser

With IntelliJ or Eclipse:

Right-click on the .feature file > Run as JUnit Test


⚙️ Karate Config & Variables

karate-config.js

Used to set environment variables:


js

Copy

Edit

function fn() {

  var config = {

    baseUrl: 'https://jsonplaceholder.typicode.com'

  };

  return config;

}

Use it in your tests:


gherkin

Copy

Edit

Given url baseUrl + '/users/1'

🔒 Authentication Support

Basic Auth:

gherkin

Copy

Edit

Given url baseUrl + '/secure'

And header Authorization = call read('classpath:basic-auth.js')

Bearer Token:

gherkin

Copy

Edit

And header Authorization = 'Bearer ' + token

📊 Advanced Features

Assertions: match, contains, ==, !=


File upload: multipart file


Call other features: call read('someFeature.feature')


JavaScript support for custom logic


HTML reporting (default JUnit-style)


📁 Directory Structure Example

arduino

Copy

Edit

src/

└── test/

    └── java/

        └── examples/

            └── api/

                ├── getUser.feature

                ├── postUser.feature

                └── karate-config.js

🧠 Summary

Feature Karate DSL Capability

REST/SOAP Support ✅ Yes

JSON & XML Handling ✅ Built-in

Parallel Execution ✅ Supported via Maven config

Data-Driven Testing ✅ Scenario Outline + Examples

CI/CD Integration ✅ Easily integrated with Jenkins/GitHub

Java Knowledge Required ❌ Minimal or none

Learn Testing Tools Training in Hyderabad

Read More

Building a CI/CD Pipeline with Selenium and Jenkins

Performance Testing with JMeter: Advanced Tips

Creating Custom Cypress Plugins

Mocking APIs in Postman

Visit Our IHUB Talent Training Institute in Hyderabad

Get Directions

Comments

Post a Comment

Popular posts from this blog

How to Install and Set Up Selenium in Python (Step-by-Step)

 Here’s your step-by-step guide to installing and setting up Selenium in Python — perfect if you're just getting started with browser automation. 🚀 🐍 Step 1: Install Python If you haven’t already: Download Python: https://www.python.org/downloads/ Make sure to check the box "Add Python to PATH" during installation Verify installation: bash Copy Edit python --version pip --version 📦 Step 2: Install Selenium Library Open your terminal or command prompt and run: bash Copy Edit pip install selenium To verify: bash Copy Edit pip show selenium 🌐 Step 3: Download WebDriver for Your Browser Depending on what browser you want to automate: 🔹 Chrome: Download ChromeDriver: ➡️ https://sites.google.com/chromium.org/driver/ Make sure the driver version matches your installed Chrome version. 🔹 Firefox: Download GeckoDriver: ➡️ https://github.com/mozilla/geckodriver/releases Unzip and place the executable somewhere on your system, like: Windows: C:\WebDrivers\ Mac/Linux: /usr/local...
Read more

Handling Frames and Iframes Using Playwright

Handling Frames and Iframes Using Playwright When automating modern web applications, you’ll often come across frames or iframes—HTML elements used to embed another HTML document within the current page. If you're using Playwright for browser automation, knowing how to handle frames properly is crucial for interacting with elements inside them. In this blog, we’ll walk through how to identify, access, and interact with frames and iframes using Playwright with code examples in JavaScript and Python. 🧾 What Are Frames and Iframes? <frame>: Rarely used now; part of the outdated <frameset> HTML structure. <iframe> (inline frame): Embeds another HTML page inside the current one. Common for third-party content like ads, maps, or payment gateways. 🎯 Why Frames Matter in Automation Elements inside an iframe are not part of the main DOM, so trying to interact with them directly will result in errors unless you switch the context to the frame. 🔍 Locating an Iframe in Pla...
Read more

Tosca for API Testing: A Step-by-Step Tutorial

Tosca for API Testing: A Step-by-Step Tutorial Tricentis Tosca is a powerful and user-friendly test automation tool that supports a wide range of testing types — including API testing. With Tosca, you can easily design, automate, and execute API tests without writing any code. It supports REST, SOAP, and other service types, making it a great choice for end-to-end API validation. 🧰 What is Tosca API Testing? Tosca’s API testing allows testers to: Send requests (GET, POST, PUT, DELETE, etc.) Validate responses (status codes, body, headers) Chain requests and share data between them Perform security, load, and functional tests on APIs ✅ Step-by-Step Guide: Tosca API Testing 🔹 Step 1: Open Tosca and Create a Workspace Launch Tosca Commander Create a new workspace (or open an existing one) Choose the workspace type as Multi-user or Single-user based on your setup 🔹 Step 2: Add a New API Test Case Navigate to the Modules section. Right-click and choose Scan > API Scan. The API Scan wi...
Read more