Creating new versions of API

When you create a new version of an API, the API gallery page displays the latest version of the API. You can view all versions of APIs from the Manage APIs page. The API details page has a drop-down list that displays all API versions.

About this task

You can create new versions of an API for the use of a different set of consumers or with different security policies. New data can also be updated to the existing metadata when you create new versions of your APIs.

The new API has the same metadata but with an updated version. The version can either be a number or a string.

Different versions of an API can be added to different communities and can be associated with different packages.

This use case starts when you want to create a new version of an existing API and ends when you create a new version of an API.

In this example, consider creating a new version of the API, Petstore 2.0 and map the newer version to the Public community.

Procedure

  1. Expand the menu options, click Manage, and click Assets.
  2. Click the version icon Version icon next to the API, Petstore.
  3. Provide 2.0 in the Version field.
  4. Select Swagger from the Type list.
  5. Select Provider1 in the Provider field.
  6. Select Public from the Community field.
  7. Select a URL from the Import with section and provide https://petstore.swagger.io/v2/swagger.json in the field.
  8. Click Save.
    A new version of the API, Petstore is created.
    Note: When you create a version of an API, you can create versions from the newer version of the API and not from the older version.
    In the example, the older API does not have the version icon Version icon appearing next to it.

What to do next

  • You can update the API by uploading a new file or by providing a new URL or pasting new content.
  • You can also map the API to another provider.
  • All consumers can view the newer verison of the API as it is a part of the public community.
  • If the API lifecyle feature is enabled, then the newly created version is kept in the Draft state. For information about the API lifecycle, see Managing lifecycle of APIs and packages.
  • Move the API to the Live state to make it available for consumers. For information on moving APIs to the Live state, see Changing the state of an API to expose it to consumers.