SAP API REVISION

[Chandan_]

In this blog post, we’ll take a closer look at API Revision. We’ll explore its features, use cases, and provide step-by-step instructions for creation API Revision and we'll discuss the difference between API REVISION and API version.

By the end of this blog post, readers will have a better understanding of API revision  and how it can be used to integrate systems in their organization.

Now, with our new API Revisions feature, you have the ability to make subsequent compatible changes to an already published API. This infographic will provide you with a sneak peek into how it works. To know more, check out the SAP help document.

 

API Revision

You can use API Revisions to make non-disruptive API changes in a safe and controlled

environment. Make subsequent compatible changes to an already published API, by creating

a revision of the API. Update changes in design time and once finalized, publish it for

consumption. You can also create multiple revisions iteratively and revert to any of the created

revisions.

 

                      Source: https://blogs.sap.com/2023/08/30/api-revision-story-in-pictures/

 

Implementation

Step 1- Create the Draft

When you create an API, a Draft gets created by default.

 

 

Step 2- Deploy the Draft

At this point, the latest revision is Draft, and you don’t have any deployed revision.

Choose Edit, to continue to have a working copy of the Draft. Choose Save after making the

changes. you can Deploy the Draft and see the Deployed Revision change to Draft.

 



 

Step 3- Create a Revision from a Draft

Select the Draft and choose Save as Revision from the inline action.

 

Enter the Name and Description and choose Save.

 

 

You can deploy this revision by choosing Click to Deploy on the message strip.

 

Step 4- Create a Draft from a Revision

Create a Draft out of the latest revision by choosing Edit. Choose Save after making the changes.

 

 

A Draft gets created out of the latest revision. You can now Deploy the new Draft or save the Draft

as a revision by choosing Save as Revision from the inline action.

 

 

Step 5- Restore a Previous Revision

If you want to deploy any previous revision or to create a draft out of it, you can do so by using

the Revert action. This action will restore a previous revision by creating a new revision which is a

copy of the previous revision you are trying to restore.

 

If the latest revision is a Draft, the revert action will discard the Draft and create a new revision.

 

To restore the API to one of its previous revisions, choose Revert from the inline action. The revert

action will create a new revision out of it.

 

 

 

For example, if you want to deploy Revision1 use the Revert action to make it your latest

revision. This action creates Revision3, which is a copy of Revision1.

 

 

 

Step 6- Delete a Revision

You can delete a revision if you don’t plan to use it any longer or if you’ve reached the maximum limit

of the number of API proxy revisions you can create.

 

 

LIMITATION OF API REVISION

• You’re not allowed to use Draft as the name of the revision, since it is reserved for draft.

 

• By default, the maximum number of revisions you can create is 20. However, this number is

configurable. If you proceed with the Save as Revision action once you’ve reached the maximum

limit, the oldest revision which is not deployed will be deleted from the list. However, if the oldest

revision is already deployed, a new revision will not be created.

 

• If the latest revision is a Draft, the revert action will discard the Draft and create a new revision.

 

• You can’t delete a Draft if both the working and the deployed copy are the same. If only one revision

exists at any given point in time, you can’t delete the same from the inline actions button. In such a

scenario, you need to delete the proxy. You can do so by choosing the Delete option from

the Additional Options on the top-right corner of the page.

 

 

Thank you for reading this blog post. Please feel free to share your feedback or thoughts or ask

questions in the Q&A .

Regards,

Chandan

[sayed42]

Very helpful, Thanks for such wonderful blog.

[himanshu_pareek]

Great blog!! Thank you for your efforts.