Graphqlbundle: Human-readable documentation
| Q | A
| ---------------- | -----
| Bug report? | no
| Feature request? | yes
| BC Break report? | no
| RFC? | no
| Version/Branch | x.y.z
Hello,
my proposal is to have a console command to generate HTML output with type definitions, mutations and resolvers linked to eachother. Something similar to graphql:debug but with data like arguments and possibility to move through various nested types etc. quickly.
Why? Easier job for front ends primarily.
Destroy666x
All 7 comments
Hello,
Just by curiosity why GraphiQL documentation does not make the job?
mcg-web
on 27 Jun 2018
Kind of, but not fully, some useful info like resolvers are missing.
Destroy666x
on 28 Jun 2018
Ok thanks for answer, do you want to submit a PR for that?
mcg-web
on 28 Jun 2018
Maybe this weekend, I'll see if I have time.
Destroy666x
on 2 Jul 2018
At job we are using an external Node.js app called graphdoc, which do exactly what you want (it even supports enums!).
The generated documentation is nice (our doc), but it requires to have Node.js and npm installed.
Kocal
on 2 Jul 2018
Good idea, didn't know that one. Could use that + a plugin for resolvers I guess
Destroy666x
on 2 Jul 2018
Seems that you got a way to solve you issue.
mcg-web
on 28 Jul 2018
Related issues
akomm
路
4Comments
Vincz
路
3Comments
tjuenger
路
3Comments
paoloposo
路
3Comments
JuanWilde
路
4Comments
Most helpful comment
At job we are using an external Node.js app called graphdoc, which do exactly what you want (it even supports enums!).
The generated documentation is nice (our doc), but it requires to have Node.js and npm installed.