Importing OpenAPI Definition from a URI

Procedure

1. Navigate to New API Definition > Import from URI. The Import an API Definition pop-up window opens.

2. In the Import an API Definition window, provide the following values:

   1. In Schema Type, select Swagger 2.0/OpenAPI 3.0.

   2. In URL, enter the OpenAPI specification URL.

   3. In Public Endpoint Domain, select a public domain from the list.

   4. Optional: In Public Endpoint Subdomain, specify a subdomain for the public domain.

   5. In Organization, select an organization from the list.

      note

      You can edit this newly created API definition only if you have API permissions for the selected organization.

   6. Click Preview.

      The Preview window shows the API definitions and endpoints that your OpenAPI URL will generate. Review and choose which endpoints to include in the API definition. By default, the system selects all endpoints.

   7. Click Save and Continue.

      note

      If duplicate endpoints are found or if the domain is not active, the system cannot create the API definition. You must either remove the duplicate endpoints from Boomi Cloud API Management (Control Center) or remove them from the OpenAPI spec you are trying to import.

3. Optional: Click View Your API to open the Interactive Documentation page, which the system automatically generates from the newly imported OpenAPI specification. This fully functional Interactive Documentation uses the specifications from the imported OpenAPI spec.

   Refer to the Interactive Documentation for more information.

4. Optional: Click Edit Interactive Documentation to edit the API definition document.

   1. Enable Default Interactive Documentation to set this as the default documentation for your API. This determines which API definition is automatically selected when the Interactive Documentation page loads.

   2. Click Save.

5. Click Add to Packages and Plans to add the API definition and endpoints to a new or an existing package and plan. Use the Packages and Plan selector to navigate to a new or an existing package and plan.

   1. To add your API definition and endpoint to a new package and plan, click the Package and Plan icon (📄), and then click Add Package and Plan.

   2. To add your API definition or endpoint to an existing package and plan, click the existing Package and Plan (✔) icon, enter some text for the list to appear, and then click Add Package and Plan.

      

      

   3. Enable the Allow self-provisioning keys checkbox to permit the use of keys without requiring developer approval.

   4. Click Save and Continue. Once the API definition and all of the endpoints have been successfully added to the package and plan, click Close.

Next Steps

On the Key & Method Detection page, configure REST API key and method settings. Refer to Configuring API Endpoint Key and Method Detection Settings for more information.