You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a new user, exploration of a API is faster if the user can search for endpoints or expand all (not fully, just to list).
The swagger-ui.html file is not configurable in anyway so adding this would requires serving your own copy of the file. Some options that should be accessible are docExpansion, javascript at the end of the page or a div for some custom html.
The default swagger-ui.html should include a button to expand all to list view. Here is a javascript bookmarklet doing this:
The default swagger-ui.html should include a searchbox of the api. Here is a bookmarklet using the API key box to do this (taken from this swagger-ui bug):
Noted that swagger-ui are working on adjusting their javascript library to add this but that doesn't change:
the ease of changing swagger-ui.html for someone who would rather be working on something else,
this being a trivial change to a default file that users can't configure in this repository that will have value to most users of the final served page.
The text was updated successfully, but these errors were encountered:
These are great ideas 🤘. Would love to get a PR since you're more familiar with this than I admit to being.
Having said that, the swagger-ui that ships with this library is more of a convenience for spring framework users rather than a full blown customized swagger-ui. The fewer customizations to the script the better we stand at taking upgrades from the mother ship.
As a new user, exploration of a API is faster if the user can search for endpoints or expand all (not fully, just to list).
The swagger-ui.html file is not configurable in anyway so adding this would requires serving your own copy of the file. Some options that should be accessible are
docExpansion
, javascript at the end of the page or a div for some custom html.The default swagger-ui.html should include a button to expand all to list view. Here is a javascript bookmarklet doing this:
The default swagger-ui.html should include a searchbox of the api. Here is a bookmarklet using the API key box to do this (taken from this swagger-ui bug):
Noted that
swagger-ui
are working on adjusting their javascript library to add this but that doesn't change:The text was updated successfully, but these errors were encountered: