swagger-api / swagger-api/swagger-ui

operationsSorter and tagsSorter in swagger-ui-react

Open
#8,072 2 comments 7 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

Content & configuration
import SwaggerUI from "swagger-ui-react";
return (
<SwaggerUI url="api.json"/>
)
Is your feature request related to a problem?

I can't find any way to set an operationsSorter or tagsSorter in swagger-ui-react. They are not exposed as props.

Describe the solution you'd like

A way to sort by operations and tags.

Describe alternatives you've considered

I tried using a swagger-config.yaml config file in the react project root as well, but it doesn't seem to do anything.

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

Start at the swagger-ui-react entry point used by the component and inspect how component props and swagger-config.yaml are handled. Trace where operationsSorter and tagsSorter are accepted, then verify that the rendered API documentation sorts operations and tags when those options are supplied.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.