Unknown macro: {next_previous_links}
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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 into it.

After creating a new version, you encourage subscribers to adopt it by depreciating the old one after a period of time. During this time, the new version can be made available as a prototyped API for users to test their applications with, without subscribing. At the time you publish a new version of an API, you can select the Deprecate Old Versions option in the Lifecycle tab to automatically deprecate all previous versions of the API.

The steps below show how to create a new version of an existing API.

  1. Log in to the API Publisher as a user with the publisher role assigned.
  2. Click the Browse menu and s elect the API that you want to create a version of (e.g., PhoneVerification 1.0.0). 
  3. The API's Overview page opens. Click the Copy button.
     

  4. Give a version number, check the default version option and click Done.

    Tip: The Default Version option means that you make this version the default in a group of different versions of the API. A default API can be invoked without specifying the version number in the URL. For example, if you mark http://host:port/youtube/2.0 as the default version when the API has 1.0 and 3.0 versions as well, requests made to http://host:port/youtube/ get automatically routed to version 2.0.

    If you mark any version of an API as the default, you get two API URLs in its Overview page in the API Store. One URL is with the version and the other is without. You can invoke a default version using both URLs.

    If you mark an unpublished API as the default, the previous default, published API will still be used as the default until the new default API is published (or prototyped).

     

  5. The All APIs page opens. Click on the new API version to open it.

  6. Click the Edit link next to the API's name.
  7. Do the required modifications to the API. 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.
  8. Click Save once the edits are done.

  • No labels
Unknown macro: {next_previous_links2}