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 available for the following stacks:

  • Java Spring Boot Stack 2.0.0 and later
  • Java Spring Boot Stack 1.0.0 (only for Domain services and always enabled)
  • NodeJS TypeScript Stack (only for Domain services and always enabled)
Note:

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.