(Maybe) GraphQL playground as dynamic docs
Opened this issue · 5 comments
When studying GraphQL with node-js I was able to explore the underlying graphql schema with the interactive documentation via GraphQL playground (based on GraphQL schema, all items are clickable there):
Hasura also has something like this via their console app, maybe it'd be possible to expose that as the API documentation:
https://hasura.io/learn/graphql/hasura/data-modelling/4-try-todos-queries/
So maybe to autogenerate API docs we could wire up one of those?
@EvgeniiaVak i think this is a great idea - are you suggesting we enable this by default on the base API page or somewhere else?
I don't really know, somewhere, the nodejs wrapper has datastore_search endpoint also which is not graphql, so it wouldn't be right to put only graphql docs in the base API page, maybe on the base API page we could have links to two docs - one for the REST endpoint, the other - to graphql
I really like this, I would make it as a separate service or plugin that can be deployed with the data-api.
I don't really know, somewhere, the nodejs wrapper has
datastore_searchendpoint also which is not graphql, so it wouldn't be right to put only graphql docs in the base API page, maybe on the base API page we could have links to two docs - one for the REST endpoint, the other - to graphql
Concerning the documentation, I also think that separating it in maybe two files REST.md and GRAPHQL.md would be a nice thing.
@leomrocha / @EvgeniiaVak can you add tasks and acceptance items to the task to summarize what work would be needed.