Package Exports

swagger-ui-customization
swagger-ui-customization/dist/index.js
swagger-ui-customization/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (swagger-ui-customization) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Swagger UI Customization

Customizes the Swagger UI with a version selector and allows you to track API version changes by adding colored tags to operations. Also automatically expands spoilers for convenience.

Usage

To apply the customization, follow these two steps:

Import setupSwaggerCustomization in the Swagger configuration file (usually setup-app.ts):

import setupSwaggerCustomization, {
  Versions,
} from 'swagger-ui-customization';

Call setupSwaggerCustomization in the onComplete configuration of Swagger:

swaggerOptions: {
    onComplete: () => {
        setupSwaggerCustomization(window, {
            '1': Versions.V1,
            '2': Versions.V2,
            '-': Versions.ALL
        });
    },
},

Pass the window object and an object with versions to setupSwaggerCustomization to define which API versions will be displayed in the version selector.