Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
When you have selected an appropriate file, click Next to load the selected file.
| |||||
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. |
|
|
The property 'swagger' or 'openapi' is missing. |
|
|
The file cannot be loaded. |
|
|
|
|
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.
When everything is configured to your needs, click Next to save the connector.
| |||
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
You can use the imported connector with the REST adapter. |
Note |
---|
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. |