Adding a Kafka API to the Project

Applies to ReadyAPI 3.10, last modified on October 07, 2021

To start testing Kafka in ReadyAPI, you should first add a Kafka API to the project. You can import an AsyncAPI definition or create an API manually.

Import API definition

  1. Click Plusnext to the APIs node and select Import API Definition:

    Show image

    — or —

    Right-click the APIs section in the Navigator and select Import API Definition.

    Show image

  2. Enter the path to the definition in the My Computer tab if the definition is stored on your computer or enter its URL in the URL tab if it is stored online. ReadyAPI will determine the type of the definition automatically, so just click Import API.

    Kafka testing in ReadyAPI: Importing definition
  3. Add the API Connection test step to a test case:

    Kafka testing in ReadyAPI: Adding the API Connection test step

    Click the image to enlarge it.

    To learn more, see API Connection Test Step.

Create API definition

  1. Add a Kafka API to the project:

    Kafka testing in ReadyAPI: Creating Kafka API

    Click the image to enlarge it.

    To learn more, see Adding More APIs to Existing Projects.

  2. Specify the service’s endpoints and authorization, if needed:

    Kafka testing in ReadyAPI: Specifying endpoint

    Click the image to enlarge it.

    To learn more, see Managing Kafka APIs.

  3. Populate the API with the needed topics:

    Kafka testing in ReadyAPI: Adding Kafka topics

    Click the image to enlarge it.

  4. Add the API Connection test step to a test case:

    Kafka testing in ReadyAPI: Adding the API Connection test step

    Click the image to enlarge it.

    To learn more, see API Connection Test Step.

Next Steps

See Also

AMQP Testing
Testing Internet of Things (IoT)

Highlight search results