Contact Us 1-800-596-4880
  1. Homepage
  2. API Experience Hub

  3. API Versioning in API Experience Hub

API Versioning in API Experience Hub

When an API specification requires nonbreaking corrections, such as changing the text, these changes are given a patch version change, such as from 3.0.0 to 3.0.1. API Experience Hub automatically and immediately imports these updates to all portals in which the API is published, without requiring any action from the API Experience Hub portal administrator.

Major Updates to an API Version

When a new version of the API with breaking changes is created, the API Experience Hub portal administrator controls when and how to publish the new version in the site. The new version appears in the API edition modal without visibility, no one is available to access this API information in the community. The administrator can set the visibility to the old and the new API versions.

For example, suppose a developer on the API team adds a new resource to an API.

  1. In Design Center, the developer opens the API project, adds the resource to the specification, and clicks Publish to Exchange.

  2. Because this is a breaking change, the developer changes the API version information in Publish API specification to Exchange.

    For example, if the API version is v3, it becomes v4. If the Asset version is 3.0.1, it becomes 4.0.0. Name and Main file don’t change.

  3. The developer clicks Publish.

  4. The previous API version remains in all portals where it was published without any changes.

The portal administrator must then review and publish the changes:

  1. In API Experience Hub, go to API Management.

    The API is still listed in APIs in the portal. The new version has visibility None.

  2. Next to the API name, click the more options icon.

  3. Change the visibility to Administrators only.

  4. Click Preview in Salesforce Builder and review the API.

  5. Go to API Management.

  6. Next to the API name, click the more options icon.

  7. Change the visibility of the new version.

    Change Administrators only to Everyone if you want it to be publicly available and Members only if you want it to be seen only by logged-in members.

    If the visibility is Everyone or Members only, then consumer developers can now see the new API version in the API Carousel on the portal.