Swagger UI

A live version of the Sterling™ Omni-Configurator REST API documentation can be accessed in a web browser using the Swagger UI . It is composed of a set of static HTML, CSS, and JavaScript that dynamically documents the available REST APIs.

Note: The Swagger UI is provided to you as-is. It contains the Sterling Omni-Configurator REST API documentation and other information that is related to the Swagger backend. Customizing the Swagger UI, for example, to display custom resource handlers, annotations, or extra data is not supported.

The following figure illustrates the Home page of the Swagger UI:

image
Where:
  • Each resource handler class is displayed with a short description of the service.
  • Show/Hide expands or collapses the API content of each class.
  • List Operations displays a summarized view of the API content, where a row is displayed for each method's path, with a short description of the service.
  • Expand Operations displays an expanded view of the API content, where rows are displayed for each method's response class, parameters, and status codes. The API can be dynamically tested by selecting Try it out! in the expanded view.