-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Expose a .well-known URI #2573
Labels
Comments
There is a proposed spec: https://apisjson.org/format/apisjson_0.17.txt I haven't reviewed it in depth yet. |
cc @kinlane |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 niceDescribe alternatives you've considered
None
The text was updated successfully, but these errors were encountered: