Creating an AsyncAPI with Event Endpoint Management

Create an AsyncAPI using Event Endpoint Management.

Before you begin

In this scenario, Event Endpoint Management can be viewed as the authoring tool for your AsyncAPI and the gateway service (and enforcement point provider). API Connect is the place where the API is surfaced, and where events are found and managed. After you create an AsyncAPI, you can package it with API Connect to offer it to consumers.

Complete the following tasks to prepare your IBM® API Connect and Event Endpoint Management:

  1. Ask your cloud administrator to Register an event gateway service.
  2. Add the event gateway to the catalog where you store the API.
  3. In Event Endpoint Management, create a topic and add an option to it. Then, publish the option. This option can be created as an AsyncAPI in API Connect.

About this task

To complete this task, you need a role with the Api-Drafts:Edit. The Developer role includes this permission by default. If you have a custom role, make sure that it includes this permission. For more information, see Creating custom roles.

Notes:
  • AsyncAPI published in Event Endpoint Management is read only i API Connect.
  • API Designer does not support creating an AsyncAPI, you must create the API by using API Manager.

Procedure

  1. In the navigation pane, click Develop icon in the API UI navigation pane Develop, then click Add > API.
    The Select API type screen is displayed.
  2. Select the AsyncAPI tab to indicate the type of API that you want to work with.
  3. In the Import section, select Event Endpoint Management, then click Next.
  4. The Add API page opens. Select the API from the instance. Then click Next.
  5. The Summary page displays messages as the AsyncAPI is generated.
  6. Click Done.