API & Specs · GraphQL macro

Newcomers understand your schema before their first query

With the GraphQL macro your schema stops arriving as thousands of lines of text. It is drawn as an interactive map on the Confluence page, so a newcomer sees how types connect before they write their first query - and onboarding takes an afternoon, not a week.

Onboarding takes an afternoon, not a week

Reading SDL top to bottom teaches nobody how a schema is shaped. A diagram does: your newcomers pan across it, zoom from the whole graph down to a single field, or open it fullscreen and follow the relationships. The question "what can I actually ask for?" answers itself, without a senior engineer's afternoon.

You show the schema you want discussed

Big graphs get noisy, so trim the view to the conversation. Hide the root Query and Mutation nodes, drop deprecated fields, leave out leaf scalars, sort fields alphabetically, and put away the docs panel and settings menu - your design review gets a clean picture instead of a busy one.

You get the map whatever form your schema is in

Paste SDL, an introspection result, or the raw response straight from your endpoint - the macro recognises which it is. Or point it at the schema where it already lives: a URL, a GitHub, GitLab or Bitbucket repository, a page attachment, Google Drive, or a credentialed S3, SFTP or database connection an admin set up once.

You take the picture into the meeting

Export the graph as PNG, JPG or PDF for a slide or an RFC, or download the schema itself from the macro. The diagram on the page stays the source everyone works from, so the copy in your deck and the schema in production started life as the same thing.

What the other GraphQL app leaves your readers doing

There is essentially one other GraphQL app for Confluence, and it is a tab that embeds a link you paste - useful for putting a playground beside your notes, but it never draws your schema. Nothing on the Marketplace does. So your choice is not between two schema maps: it is between a picture of your graph on the page, read straight from the SDL, the introspection result or the endpoint where it already lives, and a link that every reader has to follow and interpret for themselves.

GraphQL is one of 31 macros in Macro Pack

One app to install, one licence to renew, one place your team learns - and 30 more formats it already reads, from spreadsheets and diagrams to API specs and documents.

See every macro in the pack