Viewing API List and API Details
You can view the list of registered APIs, activate, delete, or view analytics of a specific API in the Manage APIs page. In addition, you can view API details, modify API details, activate and deactivate an API in the API details page.
Note:
If you encounter any problem viewing the API details with a message that says API loading has failed, this would be because the property watt.server.http.jsonFormat is set to a value that is not parsed(the default value), which API Gateway does not support.
To view API list and API details
1. Click APIs in the title navigation bar.
A list of all registered APIs appears. The APIs are sorted based on their names. When there is more than one API with same name, they are sorted based on their system versions. The Date field next to the Version field displays the API creation date.
You can also perform the following operation in the Manage APIs page.
Filter APIs by
Type,
Activation status, or
Team. Select the required API type, status, or team to view the APIs based on the provided filters.
Note:
The Team filter is applicable only if you have enabled the Teams feature.
Activate an API by clicking
that denotes an inactive state.
Once an API is activated, the Gateway endpoint is available which can be used by the consumers of this API.
Deactivate an API by clicking the status icon that denotes an active state.
Delete an API by clicking the
Delete icon.
View API analytics by clicking the
Analytics icon.
Publish or Unpublish an API by clicking
Publish and the
Unpublish icons respectively.
2. Click any API to view API details.
The API details page displays the basic information, technical information, resources and methods, and specification for the selected API. This page allows you to edit some of the API details. Also, this page provides options to activate or deactivate an API. Click
to export, enable or disable mocking, update, and create new version operations.