Kafka Tab

Applies to ReadyAPI 3.7, last modified on April 08, 2021

The Kafka tab of the Endpoints & Environments editor allows you to define environment-specific endpoints. The environment services will use these endpoints during test runs.

Environments in ReadyAPI: The Kafka tab of the Environments editor

Click the image to enlarge it.

On the Kafka tab, you can see all the available API endpoints in a table. The table has the following columns:

  • API Name – The endpoint name.

  • Endpoint – The endpoint’s URL.

  • Authorization Profile – The authorization profile used in the selected environment for the endpoint.

To edit endpoint options, click Edit in the endpoint’s row, double-click the endpoint, or select the endpoint and click .

Here, you can edit the following options:

  • Basic settings - set the endpoint’s host and port.

  • Authorization - set the authorization used in requests to this endpoint.

  • Connection Settings - configure the connection settings that will be used to connect to the Kafka broker and the schema registry.

Basic settings

Environments in ReadyAPI: The endpoint options in the Endpoints & Environments editor
Option Description
API Name

The service name.

Note: This option is read-only.
Endpoint

The endpoint's URL.

Environment

The name of the environment.

Note: This option is read-only.

Authorization

Environments in ReadyAPI: Authorization options in the Endpoints & Environments editor
Option Description
Authorization Profile

The Authorization profile. Click Configure to open the Auth Manager.

Using Auth Profiles

To use authorization profiles in environments, you need to create a profile.

Click Configure to open the Auth Manager, or configure the authorization in any specific request.

You can then select the profile in the environment options.

To learn more about authentication in Kafka, see Authentication in Kafka.

Connection Settings

Environments in ReadyAPI: Connection Settings tab in the Endpoints & Environments editor
Option Description
Confluent Settings

Used to connect to the Confluent schema registry.

  • Schema Registry URL – The URL of the schema registry.
  • Registry Authorization – The authorization profile that will be used to authenticate to the schema registry. To learn more about registry schema authentication, see Authentication in Kafka.
Publish Settings

Other parameters that your Kafka provider might require for publishing messages.

Subscribe Settings

Other parameters that your Kafka provider might require for consuming messages.

Close Subscription When

Settings that dictate when the subscription to the topic will be closed. Based on the mode chosen, the connection will close when either one of these conditions is met or when all of them are.

  • Idle Time – The time during which no new events are published to the topic.
  • Messages Received – The number of messages that the test step will receive before closing the connection. (Maximum: 500)
  • Run Time – The time elapsed after connecting to the topic.

See Also

SOAP Tab
Custom Project Properties Tab
JDBC Tab
JMS Tab
Environments

Highlight search results