Swagger-ui: 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 offical plugin catalog from what I know, but here are some plugins previously posted in the issue tracker:

• Override host, basePath, and schemes for OAS2 definitions: https://github.com/swagger-api/swagger-ui/issues/5981
• Hide the YAML/JSON file link: https://github.com/swagger-api/swagger-ui/issues/4171#issuecomment-373204614
• Hide the Base URL: https://github.com/swagger-api/swagger-ui/issues/4171#issuecomment-373204614
• Hide info.description: https://github.com/swagger-api/swagger-ui/issues/5267#issuecomment-653756972
• Add custom text above/below API info block: https://stackoverflow.com/a/52815260
• Make the API info block collapsible: https://github.com/swagger-api/swagger-ui/issues/4894#issuecomment-424487618
• Hide operations until authorized: https://github.com/swagger-api/swagger-ui/issues/4326#issuecomment-377041063
• Disable the "Authorize" button: https://github.com/swagger-api/swagger-ui/issues/3314#issuecomment-362418815
• 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: https://github.com/swagger-api/swagger-ui/issues/5020#issuecomment-653756698
• Disable the "Download" button in responses: https://github.com/swagger-api/swagger-ui/issues/4476#issuecomment-384495413
• Embed an <iframe> in the Responses section: https://github.com/swagger-api/swagger-ui/issues/4806#issuecomment-413373793
• Hide empty tags: https://github.com/swagger-api/swagger-ui/issues/4157#issuecomment-363917366
• Hide resolver errors and/or all errors: https://github.com/swagger-api/swagger-ui/issues/3366#issuecomment-363258562
• Disable the collapse feature (?): https://github.com/swagger-api/swagger-ui/issues/4630#issuecomment-396437703
• Append text to operation descriptions: https://github.com/swagger-api/swagger-ui/issues/5618#issuecomment-534389578

[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