Swagger Integration

Swagger

DeployHub Pro uses Swagger to display your microservice / API documentation, based on your Component Version. Developers create, or automate the creation of Swagger documentation. Once created the Swagger documentation can be associated to the Component Version.

Uploading Swagger Documentation

You can use the DeployHub Pro Component Detail view to manually upload your Swagger documentation for your Component. Alternatively, the recommended approach is to use the CI/CD Command Line Interface to automatically add your Swagger documentation file. Refer to the CI/CD CLI details for incorporating Swagger into your pipeline process.

Note: Swagger or OpenAPI formats can be used.

Swagger and OpenAPI File Names Scanned for

• swagger.yaml
• swagger.yml
• swagger.json
• openapi.json
• openapi.yaml
• openapi.yml

Viewing Component Swagger Data

Swagger data is associated to a particular Component Version and can be seen by going to the Component Detail View.