A new API version is created when you want to change a published API's behavior, authentication mechanism, resources, throttling tiers, target audiences etc. It isn't recommended to modify a published API that has subscribers plugged to it.
After creating a new version, you typically deploy it as a prototype for early promotion. A prototype can be used for testing, without subscription, along with the published versions of the API. After a period of time during which the new version is used in parallel with the older versions, the prototyped API can be published and its older versions deprecated.
The steps below show how to create a new version of an existing API.
- Log in to the API Publisher as a user with the
publisher
role assigned. - Click the Browse menu and s elect the API that you want to create a version of (e.g.,
PhoneVerification 1.0.0
).
- The API's Overview page opens. Click the Copy button.
Give a version number, check the default version option and click Done.
- Click the Edit link next to the API's name and do the required modifications. For example, assuming that the POST method is redundant, let's delete it from the resource that we added to the API at the time it was created.
- Click Save once the edits are done.
You have created a new version of an API. In the next tutorial, you deploy this API as a prototype and test it with its older versions.