swagger-api / swagger-api/swagger-ui
Links
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Content & configuration
Swagger/OpenAPI definition:
https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/link-example.yaml
Swagger-UI configuration options:
SwaggerUI({ })
Is your feature request related to a problem?
Links are not rendered as clickable links. This makes navigating to the operations refererred next to useless.
Describe the solution you'd like
The links section on the left should display the operation name as a clickable link that takes me to the operation in question.
Describe alternatives you've considered
Not using swagger :(
Additional context
This feature is a make or break feature for my organization where we have a lot of teams working on different APIs that all call each other. Without being able to look up the referred endpoints, we have no way of finding them.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked OpenAPI link-example.yaml and the SwaggerUI({ }) configuration, then locate the links section in the rendered Swagger UI. Done means each displayed operation name is clickable and navigates to the referenced operation; verify the behavior using the example definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100