search

swagger-api / swagger-ui

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
https://swagger.io
Apache License 2.0
26.54k stars 8.96k forks source link

Feature: Sidebar to group, navigate and search #8174

Open labarilem opened 2 years ago

labarilem commented 2 years ago

Hi everyone,

Is your feature request related to a problem?

When working with APIs that have lots of methods it's hard to navigate the page to test different methods since users usually need to scroll up/down a lot.

Describe the solution you'd like

Add an optional sidebar which supports grouping, navigation and searching of api methods, tags, etc. I had a look at an old issue https://github.com/swagger-api/swagger-ui/issues/4373 describing the same problem with the UI so I'm opening another one to understand whether the swagger-ui team is interested in this feature. I also see there is a related open issue in the swagger-editor repository: https://github.com/swagger-api/swagger-editor/issues/3269

Describe alternatives you've considered

Other API documentation solutions have this feature. E.g. Redoc: https://redocly.github.io/redoc/

Will this feature eventually make its way in the swagger-ui repository?

junior-santana commented 1 month ago

This is such an essential feature for large APIs. Do you know if that was implemented or at least discussed?