Creating Operations By Importing an OpenAPI Document

Add new operations to a service in the Service Workbench by importing an OpenAPI document. This is sometimes referred to as a Swagger document.

In order to use this feature, you will need to obtain an OpenAPI document from the service provider. For more information on this type of specification, refer to the official OpenAPI website.

Implementation:

  1. Click to access the Service Workbench tab.
  2. Select the provider and service to which you want to import operations.
  3. Open the Service Options menu and select Service Operations. This opens the Manage Operations interface where you can add and edit the service's operations.
  4. Click Import. This opens the Import From Open API dialog where you can select the file to use.
  5. You can either upload a file by clicking Browse and selecting the file you want to import, or select Import From a URL and enter the address in the provided text field.
  6. Click Import. All operations contained in the selected document will appear in the All Operations tab.
  7. Make changes to the operations and update the parameter values as required. For more information on the available options, refer to Creating an Operation for an Existing Service.
  8. Click Save to confirm the creation of the new operations.