Skip to content

OpenAPI providers

OpenAPI providers support:

  • OpenAPI version 2 or 3
  • Metadata structure that follows the common structure defined in the Swagger documentation for the version.

Note: OpenAPI providers do not support file download.

Credentials for OpenAPI providers:

  • Authentication scheme is API Key or Basic Authentication.
  • Environment depends on the version:

    • Version 2 – {baseURL}/swagger.json
    • Version 3 – {baseURL}/openapi.json

    For example,

    https://petstore.swagger.io/v2

    https://petstore3.swagger.io/api/v3

    https://api.boomi.com/api/rest/v1

Creating OpenAPI providers:

  1. Select the correct credentials object as this supplies the environment path.
  2. Enter / as the service name.

    The environment path, for example, will be https://petstore3.swagger.io/api/v3/.