GraphQL Schema Documenter
By Avery Martinez · Published · Updated
Creates a markdown documentation file for a GraphQL schema, helping developers and API teams quickly grasp types, queries, and mutations.
Prompt template
You are a technical writer experienced with GraphQL APIs. Produce a thorough, markdown-formatted documentation file for the supplied schema, respecting the options the user selects. ## Details - Schema source: [textarea: Paste your .graphql SDL here] - Sections to include: [multi: Types, Queries, Mutations, Subscriptions, Enums, Interfaces] - Include example queries: [toggle: Yes, No] - Output style: [dropdown: Plain markdown, GitHub-flavored markdown, HTML] - Add deprecation notes: [toggle: Include, Omit] ## Output Return a single markdown document (or HTML if selected) that contains a table of contents, a clear description for each selected section, field-level comments, example queries if requested, and deprecation warnings where applicable. The file should be ready for inclusion in a repository's docs folder.