While an API is the published interface, a corresponding service running in the back-end handles its actual implementation. APIs have their own life cycle, independent from the back-end service they rely on.
The following stages are available in the default API life cycle has the following stages:
- CREATED: API metadata is saved, but it is not visible to subscribers yet, nor deployed to the API Gateway.
- PUBLISHED: API is visible in API Store, and eventually published ( if the "
Propagate Changes to API Gateway" option is selected at publishing time). - DEPRECATED: API is still deployed into API Gateway (available at run-time runtime to existing users), but not visible to subscribers. An API can is automatically be deprecated when a new version is published.
- RETIRED: API is unpublished from the API gateway and deleted from the store.
- BLOCKED: Access is temporarily blocked. Run-time Runtime calls are blocked and the API is not shown in the API store anymore.
The diagram below shows the general API and backend service life cycle elements.
The Figure: API life cycle is exposed in the API publisher's end-user Web interface and and backend service life cycle elements
API Publisher has a separate tab called Life Cycle using which you can publish APIs to the API Store, depreciate, retire and perform other operations to an API. The Life Cycle tab is only visible to and manageable by a user who is assigned the " publisher " role. For instructions on creating a user with the " publisher " role, refer to section User Management.
As an example of API life cycle management, letLet's take a look at how to publish an API using the API Publisherperform some common life cycle operations on an API.
Publishing an API
...
- Log in to
...
- the API Publisher (https://<HostName>:9443/store) as a user who has
...
- the
...
- publisher
...
- role assigned.
...
...
- From the
...
- All APIs
...
- window that opens, click on the API you want to publish.
...
The API's
...
4. Select the tab named "Life Cycle." Information on the APIs state will be shown as follows:
...
| title | Note |
|---|
...
overview window opens. Click the Life Cycles tab, which displays the API's available states.
Info icon false The Life Cycle tab is only visible to users with
...
publisher
...
privileges.
...
- To publish the API, select the PUBLISHED state from the drop-down list.
...
- You get three check boxes to select as follows:
...
Propagate Changes to API Gateway
Used to define an API proxy in the API Gateway runtime component, allowing the API to be exposed to the consumers via the API Gateway. If this option is left
...
unselected, the API metadata will not
...
change and you will have to
...
manually configure the API Gateway according to the information published in the API Store.
Deprecate Old Versions
If selected, any prior versions of the API will be set to the
...
DEPRECIATED
...
state automatically.
Require Re-Subscription
Invalidates
...
current user subscriptions, forcing users to subscribe again.
...
- Select the necessary options and click the
...
- Update
...
- button to publish the API to the API Store.
...
- Note the API life cycle history
...
- visible at the bottom of the page
...
| Excerpt | ||
|---|---|---|
| ||
API life cycle management in WSO2 API Manager |
...
- .
