swagger-api / swagger-api/swagger-ui

Feature: Sidebar to group, navigate and search

Open
#8,174 3 comments 32 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name files, tests, or an entry point. Start by reviewing the related Swagger UI issue 4373 and Swagger Editor issue 3269, then inspect the existing API documentation navigation. Done means an optional sidebar can group, navigate, and search API methods and tags.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.