swagger-ui Topbar plugin is only included in Standalone

Topbar plugin is only included in Standalone

Open brpeterman opened this issue 6 years ago • 5 comments

Q&A

Method of installation: npm
Swagger-UI version: 3.21.0

Content & configuration

Swagger-UI configuration options:

        SwaggerUI({
            urls: [/* ... */],
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
                SwaggerUI.presets.apis,
                SwaggerUIStandalonePreset // Brings in TopbarPlugin
            ],
            plugins: [/* ... */],
            layout: 'CustomLayoutUsingTopbar',
            validatorUrl: null,
            displayOperationId: true,
            filter: true,
            operationsSorter: 'alpha',
            defaultModelsExpandDepth: 0
        });

Describe the bug you're encountering

The Topbar plugin is not available in the plugins property of the Swagger UI object. It seems to live in its own directory and only gets imported in the standalone preset.

To reproduce...

Steps to reproduce the behavior:

In your Swagger UI configuration, import swagger-ui as SwaggerUI.
Add SwaggerUI.plugins.Topbar to your plugin configuration.
Use a layout that includes Topbar.
Load your Swagger UI website.

Expected behavior

The website renders, topbar and all.

Actual behavior

The website does not render and there's an error in the console:

Could not find component Topbar

Additional context or thoughts

As you can see from my configuration, I can work around this by including the Standalone preset. However, that forces me to serve a whole bunch of code that does not need to go to the browser at all.