redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Expose a .well-known URI

Open Gby56 opened this issue 1 year ago • 3 comments

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

Gby56 avatar Aug 27 '24 09:08 Gby56

There is a proposed spec: https://apisjson.org/format/apisjson_0.17.txt

I haven't reviewed it in depth yet.

adamaltman avatar Sep 01 '24 16:09 adamaltman

cc @kinlane

jeremyfiel avatar Oct 23 '24 00:10 jeremyfiel

Let me know where you need help @adamaltman -- 0.18 is latest and about to push 0.19. Thanks for nudge @jeremyfiel ;-)

kinlane avatar Oct 23 '24 12:10 kinlane