Kafka APIs

Applies to ReadyAPI 3.53, last modified on June 07, 2024

In the Navigator panel, you can work with Kafka APIs to organize them for better accessibility and readability. Kafka APIs are organized in the following way:

Kafka API Structure

Click the image to enlarge it.

Kafka service

A Kafka service is a top-level node of the Kafka services in the Navigator panel. Select it to see and modify endpoints.


A channel (or topic, in Kafka terms) is a category on a broker to which publishers send data and from which subscribers read data. In ReadyAPI, channels are child nodes of the Kafka API. In their turn, channels have child nodes for publish and subscribe operations.

Add channels
  1. Click Plusnext to the Kafka API:

    Show image

    — or —

    Right-click the API in the Navigator and select Add Channel:

    Show image

  2. In the Add Channels dialog, specify the channel name and select which operations with the channel will be added to ReadyAPI. Click New Channel to specify additional channels to create:

    Testing Kafka API in ReadyAPI: Adding new Kafka channels

    Click the image to enlarge it.

  3. Click Add.


The Endpoints page is the central place where you manage endpoints used in the Kafka API.

Testing Kafka APIs in ReadyAPI: The Endpoints page

Click the image to enlarge it.

You can configure the following options:

Option Description


The endpoint URL or destination.


An environment associated with the endpoint.

You can create only one endpoint associated with each environment. When you add a new endpoint associated to the same environment, the new endpoint will overwrite the existing one.

Authorization Profile

An authorization profile used to access the endpoint.

Work with environments

When you do not use an environment, you can enter any endpoint in an API Connection test step or select one of the values specified in the Kafka API node:

Testing Kafka APIs in ReadyAPI: Set endpoins without environments

Click the image to enlarge it.

When you set an environment, the test step will use the endpoint associated with this environment:

Testing Kafka APIs in ReadyAPI: Set endpoins with environments

Click the image to enlarge it.

Organize Kafka service

Renaming items

To rename an item:

  1. Right-click it in the Navigator panel and select Rename.

  2. Enter a new item name.

Renaming an item of a composite project will change the matching item's file name.

Deleting items

To delete a item, select it in the Navigator panel and press Shift+Delete, then confirm you no longer need it.

Adding operations to functional tests

To add an operation to a functional test:

  1. Right-click the operation in the Navigator panel and select Add to Test Case.

  2. Select the test case to add the created API Connection test step to. You can also create a new test case or test suite and place the request there. Click Add Test Step.

See Also

Kafka Testing
Working With APIs

Highlight search results