Creating a Service Connector from a OpenAPI 3.0 File
Creating a Service Connector from a OpenAPI 3.0 File
You can import an OpenAPI 3.0 JSON or YAML file to easily create a service connector with multiple operations. Use the
New Service Connector from OpenAPI 3.0
wizard to import a OpenAPI 3.0 file and create a service connector. After you specify the OpenAPI 3.0 file, Application Integration parses the file and loads the operations.
If an error occurs during import, the wizard displays the error under
Error/Warnings
on the
Progress
tab. You can take corrective actions and import the OpenAPI 3.0 file again.
In
Application Integration
, click
New
on the left navigation bar.
The
New Asset
dialog box appears.
The following image shows the
New Asset
dialog box:
Click
Service Connectors
Service Connector from OpenAPI 3.0
, and then click
Create
.
The
New Service Connector from OpenAPI 3.0
dialog box appears with the
OpenAPI 3.0 Source
tab open as shown in the following image:
Specify a name, location, and description for the service connector.
In the
OpenAPI 3.0 File
section, use one of the following options to specify the OpenAPI 3.0 file that you want to import:
To use an OpenAPI 3.0 file from your local system, select
File
, and then select the OpenAPI 3.0 JSON or YAML file.
You can either select a single
.json
or
.yaml
file, or a single
.zip
file that contains self-contained
.json
or
.yaml
files.
To use a URL that contains an OpenAPI 3.0 file, select
URL
. The
OpenAPI 3.0 URL
and
Use authentication
fields appear. In the
OpenAPI 3.0 URL
field, enter the URL that contains the OpenAPI 3.0 JSON or YAML file. Select the
Use authentication
option to specify the user name and password to access the OpenAPI 3.0 URL.
If the password contains an ampersand (&) character, when you test the service connector, the action fails. Additionally, if you use the same service connector in an app connection and process, the process invocation also fails.
Click
Next
.
The
Service and Operations
tab appears.
The following image shows the
Service and Operations
tab:
From the
Service URL
list, select the endpoint that you want to use from the imported OpenAPI 3.0 file to create a service connector.
In the
Operations
section, select the operations that you want the service connector to provide.
The operations that you select will be available as actions when you create a process
and use the service connector.
Click
Next
.
The
Summary
tab appears.
The following image shows the
Summary
tab:
Review the service connector configuration.
Click
Start Import
.
Application Integration starts importing the OpenAPI 3.0 file and displays the status on the
Progress
tab. The
Progress
tab indicates whether the import completed successfully, failed, or completed with warnings.
The following image shows the
Progress
tab:
If you close the dialog box or cancel the import, the import process stops and the service connector is not created.
If the import fails or completes with warnings, click the
Error/Warnings
tab to understand why the import did not complete successfully. You can fix the issues and import the OpenAPI 3.0 file again.