Creating an OpenAPI Connector

To create an OpenAPI connector, create a new connector from the service panel, and select OpenAPI from the drop down list of available connector types. Configure OpenAPI connectors by simply importing a JSON or YAML descriptor file. Select a file via the Browse button or copy an URL directly into the input field.

OpenApi version 3.1 is not supported at the moment. Supported OpenAPI versions are 2.0, 3.0.0, 3.0.1, 3.0.2, and 3.0.3.

When you have selected an appropriate file, click Next to load the selected file:

The Next button is enabled only when you have provided a descriptor.

If the selected file cannot be loaded, a corresponding error message is displayed in the dialog:

Additionally, a (more detailed) toast message is displayed, which gives information about the respective error reason. The following messages are possible:

Displayed Message	Possible Reason	Solution
The OpenAPI version 'x.y.z' is not supported. Versions 2.0.0, 3.0.0, 3.0.1, 3.0.2, and 3.0.3 are supported.	You have selected a file in a version that is not supported.	Select a file in a version that is supported.
The property 'swagger' or 'openapi' is missing.	The mentioned properties are missing from the file or are misspelled.	Check if the basic structure of the file is correct. For more detailed information about the basic structure of an OpenAPI file refer to OpenAPI Basic Structure.
The file cannot be loaded.	The selected file is corrupt.	Select a valid file.
The file cannot be loaded.	The selected file has the wrong file type.	Select a file of a supported file type, e.g. a YAML description file.

After the selected file has been successfully loaded, you can start the actual configuration of the connector. Below Unused Operations, a list of all available REST operations provided by the REST service is displayed. From this list you can select the operations you want to use in your connector:

Click Plus on an operation to add the selected operation to the list of Used Operations.
Click X on a used operation to remove it from that list.

When everything is configured to your needs, click Next to save the connector.

The Next button is enabled only when at least one operation has been added to the Used Operations section.

The OpenAPI connector, its types, interfaces and the selected operations, have been imported to your service with the given configuration. The connector is ready to use:

The name of the connector is taken from the info/title element of the respective file:

CODE

info:
  description: |-
    # Manage support cases
     
    This REST service provides...
  title: SupportAPI
  version: '1.0'

You can use the imported connector with the REST Adapter.

To change a connector, you need to configure the connector from scratch and apply your changes. The old connector will be replaced by the new configuration.

Related Pages: