Skip to content
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

Provide API documentation for humans #163

Open
zacck-zz opened this issue Aug 6, 2018 · 0 comments
Open

Provide API documentation for humans #163

zacck-zz opened this issue Aug 6, 2018 · 0 comments

Comments

@zacck-zz
Copy link
Member

zacck-zz commented Aug 6, 2018

Is your feature request related to a problem? Please describe.
At the moment we have a nice landing page briefly explaining how a developer can plug into the API and start making calls, however features of the API have been left to the developer to discover then from the GraphQL Schema.

Describe the solution you'd like
It would be awesome if we could have an example for every query and mutation on the Schema, That way a developer can explore the application and establish what they can do with it

Describe alternatives you've considered
Considered leaving it up to GraphQL but undocumented APIs die very quickly

Additional context
Checkout the following API Documentation suggestions
https://apiary.io/how-apiary-works

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

No branches or pull requests

1 participant