Versioning APIs

Edit online

webMethods API Gateway supports the creation of new API versions from the existing versions. The new API has the same metadata but with an updated version. The version can either be a number or a string.

About this task

The API details page has a list that displays all the existing API versions. You can create a new version of an API and retain applications that are associated with older versions of the API. When an API is updated, it retains the Expose to consumers settings, the existing scope definitions, the configured policies, and the REST-enabled path configurations for SOAP API.

When you create a new version, the newer version is assigned to the teams of the older version by default. You can later change the teams, if required.

You must have the webMethods API Gateway's manage APIs functional privilege to perform this task.

You can create a new version of an API from the latest version available for the API. For example, if the existing version is 1.1 for an API, you can create a version 1.2. If you want to create a version 1.3, you can create it only from the latest version 1.2 and not from 1.1. However, you can delete the intermediate versions. When you create a new version of the API, you are the owner of the newly created version of the API, even if the earlier owner is a different provider. The new API version is in an inactive state, irrespective of the state of the API in its previous version.

Procedure

  1. Open the menu options and select APIs.
  2. Select the required API from the list of APIs.
  3. Click icon and select Create new version.
  4. In the Version field, type the new version for the API.
  5. Clear the Retain applications checkbox if you do not want to retain applications that are associated with older versions of the API.
  6. Click Create.
    The Version lists the newly created API version in latest to older order in the API details page. When you select any particular version, the corresponding API details page is displayed.
    Note: The version is appended to the URL of the Gateway endpoint after the API is activated. You can view this change in the Technical information section of the API details page. When a client application invokes the API without the version in the endpoint, webMethods API Gateway invokes the latest version.