search

apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.64k stars 2.14k forks source link

GraphQL Endpoint Example #346

Open yuchunc opened 7 years ago

yuchunc commented 7 years ago

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.

zdne commented 7 years ago

@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..