Plugin catalog ?

[ChristopherHackett]

Does a plugin catalog exist?

I am about to attempt to extend the functionality of swagger-ui but before I do I want to find if someone else has written something similar.

Whilst I can find documentation on the plugin API I can't find any catalog of know plugins and/or how to search some other site for them.

I checked the github issues but could not find anything relevant.

(As an example I'm looking for if anyone has done anything about accessing spec files with authentication)

[hkosova]

There's no official plugin catalog from what I know, but here are some plugins previously posted in the issue tracker or created by community members:

• Hierarchical tags: https://www.npmjs.com/package/swagger-ui-plugin-hierarchical-tags
• Override host, basePath, and schemes for OAS2 definitions: Mechanism to override host, basePath and scheme for OpenAPI 2.x definitions #5981
• Hide the YAML/JSON file link: Means to prevent the display of the OpenAPI specification URL link. #4171 (comment)
• Hide the Base URL: Means to prevent the display of the OpenAPI specification URL link. #4171 (comment)
• Hide info.description: Hide info.description #5267 (comment)
• Add custom text above/below API info block: https://stackoverflow.com/a/52815260
• Make the API info block collapsible: Display documentation similar to operations?  #4894 (comment)
• Hide operations until authorized: Divide API in public and private #4326 (comment)
• Disable the "Authorize" button: How to remove Authorize and Try it Out buttons #3314 (comment)
• Disable "try it out" for OAS3 definitions without servers: https://github.com/shockey/swagger-ui-plugins/tree/master/packages/disable-try-it-out-without-servers
• Hide the cURL command from responses: Need way to hide curl command from swagger response using configuration #5020 (comment)
• Disable the "Download" button in responses: Disable download button in response body #4476 (comment)
• Embed an <iframe> in the Responses section: How to embed a link into each operation in Swagger UI #4806 (comment)
• Hide empty tags: After Tag-Grouping APIs, SwaggerUI renders empty controllers/empty tags #4157 (comment)
• Hide resolver errors and/or all errors: v3 - Resolver error - Cannot read property '1' of undefined #3366 (comment)
• Disable the collapse feature (?): Custom Plugin: Using wrapComponents to override container behavior #4630 (comment)
• Append text to operation descriptions: Custom Plugin: Using wrapComponents to modify operation description #5618 (comment)

[hkosova]

I'm looking for if anyone has done anything about accessing spec files with authentication

This can be done by using the requestInterceptor option. Here's an example of loading a spec protected by Basic auth.

[ChristopherHackett]

Thanks for the pointers. Looks really useful. 👍

I was expecting to see some plugins packaged up on npm but it seems these are usually small snippets of code added via the plugin mechanism. This probably explains why I struggled to find them at first.

[shockey]

Closing due to inactivity.

This is simply to keep our issue tracker clean - feel free to comment if there are any further thoughts or concerns, and we'll be happy to reopen this issue.

Also, note that I linked to this issue from my Swagger UI plugin repo - I'm doing work there to ship plugins to npm, and create a template for future plugins.

[AdrieanKhisbe]

(for future readers)

Also, note that I linked to this issue from my Swagger UI plugin repo - I'm doing work there to ship plugins to npm, and create a template for future plugins.

👉 https://github.com/shockey/swagger-ui-plugins

[an9r0f]

add my plugin

[sh-at-cs]

@hkosova Could you please add @kael-shipman's hierarchical tags plugin from #5969, i.e. https://www.npmjs.com/package/swagger-ui-plugin-hierarchical-tags ? Pretty useful if you ask me.