Swagger UI Support
Introduction
A Swagger UI allows to visualize and easily access REST APIs offered by services. It is a common way to share the modelled API with consumers, so that the offered operations can be inspected. It also provides the possibility to try out the offered actions in a convenient way, which can be helpful during service development.
Swagger UI Support in IBM Industry Solutions Workbench
IBM Industry Solutions Workbench provides the possibility to easily include a Swagger UI for your developed services which provides access to the REST APIs modelled within the service.
The extension is only available if API Modelling Extension is enabled as well.
Swagger UI in the Solution Envoy
The Solution Envoy automatically comes with a Swagger UI, which allows to access any API modelled within a service, that is deployed on the deployment target. This way, REST APIs of services can easily be inspected and tried out.
When Swagger UI Support is enabled for a project based on Java Spring Boot, a Swagger UI will be built and packaged within the developed service as well. This Swagger UI can be used within local development of the service. To find out more about this feature, please see Setup Java local profile - Swagger UI. Additionally, the Swagger UI will be available after Single Service Deployment or Deployment via Application Composition.