Exposing the basic server information
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
It just occurred to me that the base url and server variables aren't really exposed with redoc. (OpenAPI 3 spec)
How is anyone supposed to know how to use the API if they can't see that they're supposed to go to http://api.example.com/{version_number}/?
Now that I explicitly go looking for it I see that it's only visible by clicking on the "GET" buttons - where it appears as part of the example url but that's really hard to discover, and doesn't expose any info about the server variables. It's completely invisible unless you look for it or stumble across it.
I feel that swagger-ui does this properly - it exposes that stuff early at the top of the page.
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 by locating the Redoc page component that renders the OpenAPI 3 server information, then compare its current placement with the behavior described for swagger-ui. The work is done when the base URL and server variables are visible near the top of the API documentation without requiring users to expand an endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100