Visualizing and Testing REST Service Bindings Using Swagger

Swagger scans the application code and exposes the documentation on the URL. You can consume this URL (a JSON document) to understand the capabilities of the REST service without accessing the actual source code and documentation.

For more information on Swagger, see https://swagger.io/.

Swagger is built around OpenAPI Specification. Currently, it uses Swagger Specification version 2.0 and Application API version 1.0. The specification defines a set of files required to describe the API. The files can be written in YAML or JSON format. These files can then be used by the Swagger UI to display the API. For more information on the OpenAPI Specification, see https://swagger.io/specification/.

Using Swagger UI integrated with the Application Monitor, you can:

• View all REST service endpoints and operations on each endpoint implemented by the REST service.
• Examine the inputs and outputs for each operation in JSON format with detailed schema.
• Allow end developers to effortlessly interact and try out every single operation that the API exposes for easy consumption. Specify JSON, BJSON, or XML as the content type for a Request and Response for each operation.
• Invoke an operation and receive a live response for the input specified.
• Generate and download a Swagger.json file.