Graphql query response - field mapping documentation

[Kamaraj_AEM]

For each component, I need to create a new GraphQL query and share it with the consumer team.

To streamline this process, I am preparing a technical mapping document for the module's GraphQL query responses and VD image.

Is there an efficient way to generate documentation for GraphQL responses?

Field Mapping Screenshot:

Note: I tried swagger API. It is helpful for only REST API

Thanks!

[EstebanBustamante · Accepted solution]

Hi,

I think you might want to look beyond Adobe’s ecosystem for a more general GraphQL solution. Here are a few interesting options I haven’t tried myself but that could be worth exploring:

- https://github.com/anvilco/spectaql (SpectaQL is a Node.js library that generates static documentation for a GraphQL schema)
- https://github.com/2fd/graphdoc?tab=readme-ov-file (Static page generator for documenting GraphQL Schema)

- https://github.com/graphql-markdown/graphql-markdown 

Hope this helps

 

[ManviSharma]

Hello,

Here are a couple of good documentation links to get you started with GraphQL-docs generation:

• SpectaQL: “Autogenerate static GraphQL API documentation” — GitHub repo + config examples.
  
  https://github.com/anvilco/spectaql
  
  Graphdoc (aka @2fd/graphdoc): Static page generator for GraphQL schema → install + usage instructions:
  https://2fd.github.io/graphdoc/