Creating a new version of an API definition

You can create multiple versions of an API definition and edit the versions independently by using IBM® API Connect.

About this task

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

Note: If you want to publish a modified API to a production Catalog, you must create a new version of the API. You cannot publish an API to a production Catalog if there is already a published API with the same name and version.

Procedure

To create a new version of an API definition, complete the following instructions:

  1. In the navigation pane, click Develop icon in the API UI navigation pane Develop, then select the APIs tab.
  2. You can create a new version of an API definition either from the Develop page, or from within the API definition itself.
    1. To create a new version of an API definition from the Develop page, complete the following steps:
      1. Alongside the API version that you want to work with, click the options icon options icon, then click Save as a new version. The Save API as a new version window opens.
      2. Enter your new version number, then click Save.
    2. To create a new version of an API definition from within the API definition itself, complete the following steps:
      1. Click the title of the API definition that you want to create a new version of.
      2. Click the options menu icon:
        Screen capture highlighting the options menu icon
      3. Click New Version, enter your new version number, then click Submit.
    Note: The version corresponds to the info.version property value of the API's OpenAPI definition. The version.release.modification version numbering scheme is recommended, for example 1.0.0.

Results

You have created a new version of your API definition, which you can now edit independently of other versions. Each version of the API definition is listed separately on the APIs and Products page.