Expose a .well-known URI
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
Automatic discovery of API documentation portals is not easy, even with great documentation websites, automatically downloading the up-to-date schemas is not an easy task.
Describe the solution you'd like
My first idea is to use https://en.wikipedia.org/wiki/Well-known_URI
Either a /.well-known/apis.json or /.well-known/redoc.json would be enough, to get a simple list of documented APIs on the portal you're browsing, and get the list of specification files there too, to simply download the specifications.
Otherwise another URL path would be ok, a simple exampleportal.com/redoc.json would be nice
Describe alternatives you've considered
None
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
The issue names no implementation files, tests, or entry points. Start by tracing how Redoc exposes documentation and specification URLs, then define which well-known URI is supported and what discovery data it returns; done means a documented, test-covered way to discover the portal's APIs and specification files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100