{"id":46921,"library":"amplify-graphql-docs-generator","title":"AWS Amplify GraphQL Docs Generator","description":"Plugin for the AWS Amplify CLI that auto-generates GraphQL documentation from AppSync schemas. Current stable version is 2.2.4. Part of the Amplify CLI ecosystem, it transforms GraphQL schema definitions into human-readable markdown documentation. Unlike general-purpose GraphQL doc tools, it's tightly integrated with Amplify workflows and supports AWS AppSync features like custom directives and resolvers. Low release cadence (last update in 2021) as it's component of a larger toolchain.","status":"maintenance","version":"2.2.4","language":"javascript","source_language":"en","source_url":"https://github.com/aws-amplify/amplify-cli","tags":["javascript","graphql","appsync","aws"],"install":[{"cmd":"npm install amplify-graphql-docs-generator","lang":"bash","label":"npm"},{"cmd":"yarn add amplify-graphql-docs-generator","lang":"bash","label":"yarn"},{"cmd":"pnpm add amplify-graphql-docs-generator","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Package is ESM-only in v2. CJS require will fail. Use dynamic import if needed.","wrong":"const { generateDocs } = require('amplify-graphql-docs-generator')","symbol":"generateDocs","correct":"import { generateDocs } from 'amplify-graphql-docs-generator'"}],"quickstart":{"code":"import { generateDocs } from 'amplify-graphql-docs-generator';\nimport { readFileSync, writeFileSync } from 'fs';\n\nconst schema = readFileSync('./schema.graphql', 'utf8');\nconst docs = generateDocs(schema, {\n  template: 'default',\n  language: 'en'\n});\nwriteFileSync('./docs.md', docs);","lang":"typescript","description":"Generate GraphQL documentation from an AppSync schema file and save as markdown."},"warnings":[{"fix":"Upgrade Node.js to version 12 or later.","message":"Requires Node.js >=12.0.0","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Consider migrating to @aws-amplify/graphql-docs-generator if available.","message":"Package is in maintenance mode; no new features expected.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Provide schema as a string in SDL format, not as an introspection result.","message":"Schema must be valid GraphQL SDL; does not support .graphqlconfig or introspection JSON.","severity":"gotcha","affected_versions":">=2.0.0"}],"env_vars":null,"search_vec":"'2.2.4':25 '2021':73 'amplifi':2,10,29,55 'appsync':19,60,84 'auto':14 'auto-gener':13 'aw':1,9,59,85 'cadenc':69 'cli':11,30 'compon':77 'current':21 'custom':63 'definit':36 'direct':64 'doc':4,48 'document':17,42 'ecosystem':31 'featur':61 'general':45 'general-purpos':44 'generat':5,15 'graphql':3,16,34,47,83 'human':39 'human-read':38 'integr':53 'javascript':82 'larger':80 'last':70 'like':62 'low':67 'markdown':41 'part':26 'plugin':6 'purpos':46 'readabl':40 'releas':68 'resolv':66 'schema':20,35 'stabl':22 'support':58 'tight':52 'tool':49 'toolchain':81 'transform':33 'unlik':43 'updat':71 'version':23 'workflow':56","created_at":"2026-06-07T16:48:34.950549+00:00","updated_at":"2026-06-07T16:48:34.950549+00:00","problems":[{"fix":"Use import instead of require, or use dynamic import: const mod = await import('amplify-graphql-docs-generator');","cause":"Attempting to use require() with this ESM-only package.","error":"Error: Cannot find module 'amplify-graphql-docs-generator'"},{"fix":"Verify import: import { generateDocs } from 'amplify-graphql-docs-generator';","cause":"Incorrect import (e.g., using named import but package uses default export).","error":"TypeError: generateDocs is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/aws-amplify/amplify-cli#readme","github":"https://github.com/aws-amplify/amplify-cli","docs":null,"changelog":null,"pypi":null,"npm":"amplify-graphql-docs-generator","openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}