Creating a connector by using an OpenAPI document

The OpenAPI Specification, previously known as the Swagger Specification, is a definition format for describing REST APIs. You can import an OpenAPI document that contains API definitions into the Connector Development Kit to create a connector as a quicker and alternative way to creating a connector from scratch.

Important: The OpenAPI document must conform to the OpenAPI Specification Version 2.0 or 3.0.x.

To create a connector by using an OpenAPI document, complete the following steps:

1. Log in to your Connector Development Kit instance.

2. On the Connector Development Kit home page, click Create a connector.

   The Create a connector page is displayed.

3. From the 'Import or discover' view, select Import connector from an OpenAPI document, then click Next.

4. From the 'Add connector metadata' view:

   a. Import your OpenAPI document into the designated box.

   b. Enter a name for the application and optionally add a description.

   c. In the Category field, select a category for your connector. Categories are used to filter connectors when they are published to IBM Automation Explorer.

   d. In the image section, click the Edit icon to add an image for your connector or use the default app image that is provided by the Connector Development Kit.

   e. Specify a version for your connector. For more information, see Connector versioning.

5. Click Next.

6. From the 'Preview actions' view, review the list of available objects and associated actions added from the OpenAPI document.

7. Click Create.

   A notification is displayed to indicate that the connector is created successfully. Notice that the Actions, Events (if available), Connection properties, and Schema tabs are populated with the details from the OpenAPI document.

8. Test the new actions and polled events that you created by using the Test actions and Test events tab. For more information, see Testing a connector.