API Revisions

Publishing displays the API in the Developer Portal, and deployment makes the API available for invocation via a Gateway. In previous versions of MWARE ESB, API publishing and deployment in Gateways were tightly coupled. In the API life cycle, whenever the publisher promotes an API to the Published state, the API will be displayed in the Developer Portal as well as deployed in the specified Gateway environments. The publisher only has two options regarding API deployment: either to deploy the current state of the API in a Gateway or not deploy the API at all.

The Publisher Test Console provides a space to test the API before publishing and deploying an API. However, the Test Console does not provide the option to test the API in an actual Gateway with the runtime configurations. Making such changes to an API without proper testings and especially if the changes are reflected instantly in the Developer Portal and all the serving Gateways, is not a good approach for a production setup.

With the introduction of API Revisions and API Product Revisions, previously coupled publishing and deployment operations have been decoupled. The API publisher has more control over the API deployments and also has the ability to introduce recoverable changes to the API project. API revisions are similar to a checkpoint in time, capturing the current state of the API when the revision is created. If the changes have an adverse effect on the API once it is deployed in a Gateway environment, you can quickly recover to the previous state of the API. In addition, even if you want to test out a new run time configuration, this concept provides the ability to test it in an independent Gateway before applying the same change to all the Gateways.

Architectural changes and key features

The revision feature brings in a few architectural changes to the previous versions of MWARE ESB.

  • Changing the life cycle state to Published will only display the API in the Developer Portal and will not handle the deployment anymore.
  • Deploying an API in a Gateway requires an additional step. The publisher has to create a revision and deploy that revision in the required Gateway environment(s).
  • A single API or API Product can have multiple revisions (a maximum of 5, and once the max limit is reached, you have to delete a revision before creating a new one).
  • If there are multiple Gateways, you have the option to deploy the same revision across all the Gateways or different revisions of the API in each Gateway. Each Gateway will handle the API requests differently based on the deployed revision.
  • Create and deploy the API in a Gateway without changing the lifecycle state to Published.
  • The revisions cannot be edited.
  • To discard the latest changes, you have the ability to restore the API to a specific revision.

Deploy a revision

Follow the instructions below to either deploy a new revision or deploy an existing revision in a given Gateway Environment:

Depoly a new revision

Follow the instructions below to deploy a new revision for an API:

  1. Sign in to the Publisher.

    https://localhost:9443/publisher

  2. Navigate to the Deploy section and click Deployments.

    The Deployments page appears as follows when you do not have any existing revisions.

    New revision

    The Deployments page appears as follows when you have at least one revision.

    Deploy new revision option

    Note

    The Information icon will appear only if you have added a product revision description. You can view the description when you hover over the information icon.

  3. Click Deploy New Revision.

    Note

    Skip this step if you are creating your very first revision.

  4. Optionally, provide a description for the revision.

  5. Select the API Gateways in which you want to deploy the API.
  6. Click Deploy.

Warning

You cannot deploy more than 5 revisions. If you want to deploy a new revision after the maximum allowed number of revisions are reached, you need to delete one of the existing revisions.

Delete revision if max count is reached

Deploy an existing revision

Follow the instructions below if you need to deploy an existing revision on a given Gateway Environment:

  1. Sign in to the Publisher.

    https://localhost:9443/publisher

  2. Navigate to the Deploy section and click Deployments.

  3. Select the required revision from the Deployed Revision drop-down menu.

  4. Click Deploy.

    Deploy an existing revision

Create a new revision

Follow the instructions below to create a new revision from your existing API:

  1. Sign in to the Publisher.

    https://localhost:9443/publisher

  2. Navigate to the Deploy section and click Deployments.

  3. Click + in the revision timeline.

    Create new revision

  4. Optionally, provide a description for the revision.

  5. Click Create.

Warning

You cannot create more than 5 revisions. If you want to create a new revision after the maximum allowed number of revisions are reached, you need to delete one of the existing revisions.

Delete revision if max count is reached

Undeploy a revision

Follow the instructions below if you need to undeploy a revision from a Gateway Environment:

  1. Sign in to the Publisher.

    https://localhost:9443/publisher

  2. Navigate to the Deploy section and click Deployments

  3. Click on the Undeploy button that appears against the respective Gateway Environment from which you want to undeploy the revision.

    Undeploy a revision

Delete a revision

If you need to delete a specific revision, click on the Delete button that corresponds to the respective revision in the revision timeline as shown below.

Note

  • If a revision is already deployed in a specific environment, you cannot delete it.
  • You should first undeploy the revision from the Gateway Environment and then delete it.

Delete a revision

Restore a revision

API revisions can not be updated. Therefore, when you update an API via the Publisher Portal, the changes will get reflected in the Current API, which is the current state of the API. Any changes to the API, such as a change in a mediation policy, security configurations, documentation or simply changing the description of the API, etc., will deviate the state of the Current API from the latest revision. If the API is in the Published state, the changes available in the Current API state are displayed in the Developer Portal.

Note

If you do not create a revision with your latest changes before restoring a previous revision, your latest changes in the Current API will be lost.

If you need to revert these changes and restore a specific revision, click on the Restore button in the revision timeline, as shown below. Thereby, this will restore that specific revision into the Current API, overriding the changes that are currently available in the Current API. As the restore option will only update the Current API in the Publisher and Developer Portal, it does not have any effect on the deployed revisions.

Restore a revision

Top