Specifying the schemes for an API

Schemes define which transfer protocols you want your API to use.

About this task

Note: This task relates to configuring an OpenAPI 2.0 API definition. For details on how to configure an OpenAPI 3.0 API definition, see Editing an OpenAPI 3.0 API definition.

You can complete this task either by using the API Designer UI application, or by using the browser-based API Manager UI.

At any time, you can switch directly to the underlying OpenAPI YAML source by clicking the Source icon OpenAPI Source icon. To return to the design form, click the Form icon Form icon.

Procedure

  1. Open the API for editing, as described in Editing an OpenAPI 2.0 API definition.
  2. Expand the General section then, if there are already one or more schemes defined, expand Schemes List.
  3. To specify a new scheme, click the add icon OpenAPI 2.0 API add icon alongside Schemes List. To modify an existing scheme, click the scheme entry in the navigation pane.
  4. Select the required scheme from the list provided, then click Create.
  5. Click Save when done.