kael-shipman / swagger-ui-plugins

Useful plugins for Swagger UI v3

✨ Swagger UI Plugins

A multi-package repository of useful Swagger UI plugins maintained by @shockey.

---

IMPORTANT: THIS IS A FORK

This is a fork of https://github.com/shockey/swagger-ui-plugins. That repo appears not to be maintained anymore. This branch (combined) is the combination of all of the PRs that I've submitted to shockey/swagger-ui-plugins. Those are:

• Created plugin boilerplate and new-plugin script
• WIP: More plugins
• WIP: Hierarchical tags

I have largely abandoned those PRs, since it appears they won't be attended to, but if @shockey becomes active again, I will gladly push them through.

Import information about this fork

This fork mainly exists to provide the Hierarchical Tags plugin that many people are looking for (see here).

Instructions for installing and using that plugin are here.

---

👉 Available Plugins

• disable-try-it-out-without-servers: enter documentation-only mode when OAS 3.0 servers is empty or missing
• hide-empty-tags: hide empty tags
• url-mutator: mechanism to override path, basePath and scheme for OpenAPI 2.x definitions
• disable-oas-spec-link: prevent the display of the OpenAPI specification URL link
• hierarchical-tags: use a delimiter character to split tags into a hierarchy and display them with better grouping

Contributing

Feel free to open issues and pull requests that fix bugs, add functionality, and introduce new plugins.

I will make releases of each plugin when/if your PR is accepted.

Please add yourself to the Contributors list below if you add a new plugin!

You can use the npm run new-plugin command to easily generate a new plugin skeleton from boilerplate. This should give you at least a reasonable head start on your plugin in a way that is generally compatible with the conventions in this library.

One easy way to contribute is to copy over plugins found at swagger-api/swagger-ui#5027 (comment).

Versioning

Each plugin uses SemVer for versioning.

A plugin's version is unrelated to its Swagger UI compatibility: compatible versions are indicated by the plugin's Swagger UI peerDependency.

Contributors

• Kyle Shockey: Initial work; plugin maintenance
• Kael Shipman: Plugin boilerplate and script; limited ports of other people's plugins from around the web.

Built With

• Lerna - a tool for managing JavaScript projects with multiple packages
• Babel - a JavaScript compiler
• Cypress - fast, easy & reliable testing for anything that runs in a browser

License

This project and all of its packages are licensed under the MIT License.