REST API details

Edit online

The REST framework helps you to model APIs conforming to the (Resource Oriented Architecture) ROA design. For example, you might model an API that serves to expose the web service data and functions as a collection of resources. Each resource is accessible with unique Uniform Resource Identifiers (URLs). In your API, you expose a set of HTTP operations (methods) to perform on a specific resource. You can then capture the request and response messages, and status codes that are unique to the HTTP method and linked within the specific resource of the API.

The API details view for a REST API displays the details of the API such as Basic and Technical information, Resources and methods, API mocking details, and specifications. You can also view the scopes that are associated, policies that are enforced, registered applications, and the API-specific analytics.

The table lists the API details displayed for the API:

Field Description
Basic information Displays the information about the API, such as name, version, description, owner of the API, and the teams that the API is assigned to. Also, you can view the status of the API whether its is Active or Inactive, the maturity state of the API, the date of API creation.
Technical information Displays the native endpoints of the API.
Resources and methods Displays a list of resources or methods available in the API sorted by resource and path name. The list of resources are displayed in sorted order of the path names. Click each resource to view the corresponding HTTP methods, along with a summary. You can view details such as parameters and response codes for each of these methods.
API mocking Details are visible only when API mocking is enabled. The details include a list of mocked responses for the operations in the API, custom IS service list, and conditions along with its mocked response.
Components Displays the schemas that are defined at the API level.
Documentation Displays the definition of the API in different formats.

Various tabs that are displayed in the API details page display the following details.

  • The Scopes tab lists the scopes available for the API.

  • The Policies tab displays the policies that are enforced for the API.

  • The Mashups tab displays the mashups that are defined in the API.

  • The Applications tab displays all the applications that are registered with the API.

  • The Analytics tab displays the API-specific analytics for the time interval selected.

You can perform the following operations from the API details page:

  • You can enable API mocking by clicking Enable mocking. If API mocking is enabled, you can disable it by clicking Disable mocking. This option is available when the API is in the deactivated state.

  • You can update an API by importing from file or from URL by clicking Update. This option is available when the API is in the deactivated state.

  • You can create a new version of the API by clicking Create new version.

  • You can modify details of an API by clicking Edit. This option is available when the API is in the deactivated state.

  • You can activate an API by clicking Activate. If the API is already activated, you can deactivate it by clicking Deactivate