Api-blueprint: GraphQL Endpoint Example
Hi, I am trying to write a GraphQL Apiary documentation for my team, but doesn't see one yet.
Do you have some suggestions? It has to cover both query and mutation usage.
If I got time later, I could submit a pull request.
Question
yuchunc
👍2
>All comments
@yuchunc,
at this point you can document the GraphQL endpoint and pretty much define all the types with MSON / Attributes however you will have problems with queries and mutation definitions.
At this moment API Blueprint is tailored to HTTP APIs and not really useful with RPC-like API (such as GraphQL). There is a plan to abstract protocol layer and enable other API styles but no work has started on it..
zdne
on 1 Aug 2016
👍4
❤1
Was this page helpful?
0 / 5 - 0 ratings
Related issues
bennettellis
路
7Comments
Perni1984
路
6Comments
jrep
路
10Comments
annappropriate
路
5Comments
BigBlueHat
路
3Comments
Most helpful comment
@yuchunc,
at this point you can document the GraphQL endpoint and pretty much define all the types with MSON / Attributes however you will have problems with queries and mutation definitions.
At this moment API Blueprint is tailored to HTTP APIs and not really useful with RPC-like API (such as GraphQL). There is a plan to abstract protocol layer and enable other API styles but no work has started on it..