DEV Community

loading...

Versioning APIs In Anypoint Platform

sadiktech profile image Sadik Ali ・2 min read

Artifices for API versions on Anypoint Platform:

Follow a split plan on versioning APIs:

Make sure to make all changes to APIs backwards-compatible.
However, believe that contrary modifications will be required at any point and forward version of your APIs from the start.
An API versioning approach is evident everywhere in the application network and should therefore be standardized by the C4E.

On Anypoint Platform the version of an API is noticeable in these places:

The URL of the API endpoint
The RAML representation of the API: version and baseUri
The Anypoint Exchange entry (asset) for the API: "API version", "Asset version", "API instances".
The Anypoint API Manager listing for an API instance: "API version", "Asset version", "Implementation URL" and "Customer endpoint".
Perception connotative versioning of APIs on Anypoint Platform:

Use semantic versioning with major, minor, and patch version numbers for APIs:

Major.minor.patch:

Major versions include backward-incompatible changes in the structure of the API that require API clients to adapt.
Minor versions introduce backward-compatible changes to the API that do not require API clients to improve unless the API client aspires to take the assistance of the newly introduced changes.
Patch versions introduce small fully backward-compatible fixes, so as documentation corrections.
If semiotic versioning is accompanied, then version 1.2.3 of an API is an entire stand-in for variant 1.1.5, and so all API clients that have previously used version 1.1.5 can be made to use version 1.2.3 instead, without having to be created aware of the development. For this speculation, typically, only the significant version of an API is made visible to API consumers.

This means that only the major version of the API should be visible in

The URL of the API endpoint.
The RAML representation of the API in both versions and baseUri.
The Anypoint Exchange record (asset) for the API in "API version".
The Anypoint API Manager entry for an API instance in "API version", "Implementation URL" and "User endpoint".
By contrast, the full connotative version is noticeable in

• The Anypoint Exchange record (asset) for the API in "Asset version" and "API instances".

• The Anypoint API Manager listing for an API instance in "Asset version".
Enter fullscreen mode Exit fullscreen mode

Here is because

• the Anypoint Exchange entry of type "REST API" also saves the RAML description itself.

• the Anypoint API Manager entry for an API situation may depend on that API specification for the representation of API policies that apply only to selected federations of API resources and HTTP methods.

Discussion

pic
Editor guide