Skip to content

Add API explorer tool #2929

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

Open
brainwane opened this issue Feb 12, 2018 · 1 comment
Open

Add API explorer tool #2929

brainwane opened this issue Feb 12, 2018 · 1 comment

Comments

@brainwane
Copy link
Contributor

For the existing API endpoints, we could use https://readme.io/ or something like it to provide an API explorer tool -- an in-browser sandbox so a developer can interactively try out the provided endpoints and methods.

@miketheman
Copy link
Member

I was thinking about this recently, along with other open issues about API documentation.

Considering using apispec to add documentation to API endpoints and then generate the UI based on the notations.

This would require a top-level route to serve the UI, or use an existing route and use content negotiation to serve if requesting HTML.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants