Registry / testing / amplify-graphql-docs-generator

amplify-graphql-docs-generator

library2.2.4jsnpmunverified

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.

testing

npm install amplify-graphql-docs-generator

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AMPLIFY-GRAPHQL-DO

amplify-graphql-docs-generator

testingjavascriptv2.2.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generateDocs

✓ import { generateDocs } from 'amplify-graphql-docs-generator'

✗ const { generateDocs } = require('amplify-graphql-docs-generator')

Package is ESM-only in v2. CJS require will fail. Use dynamic import if needed.

Generate GraphQL documentation from an AppSync schema file and save as markdown.

import { generateDocs } from 'amplify-graphql-docs-generator'; import { readFileSync, writeFileSync } from 'fs'; const schema = readFileSync('./schema.graphql', 'utf8'); const docs = generateDocs(schema, { template: 'default', language: 'en' }); writeFileSync('./docs.md', docs);

Debug

Known issues

breakingRequires Node.js >=12.0.0

fix

Upgrade Node.js to version 12 or later.

affects: >=2.0.0

deprecatedPackage is in maintenance mode; no new features expected.

fix

Consider migrating to @aws-amplify/graphql-docs-generator if available.

affects: >=2.0.0

gotchaSchema must be valid GraphQL SDL; does not support .graphqlconfig or introspection JSON.

fix

Provide schema as a string in SDL format, not as an introspection result.

affects: >=2.0.0

Errors

Common errors & fixes

Error: Cannot find module 'amplify-graphql-docs-generator'

Attempting to use require() with this ESM-only package.

fix

Use import instead of require, or use dynamic import: const mod = await import('amplify-graphql-docs-generator');

TypeError: generateDocs is not a function

Incorrect import (e.g., using named import but package uses default export).

fix

Verify import: import { generateDocs } from 'amplify-graphql-docs-generator';

Upgrade

Version history

2.2.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

35 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/aws-amplify/amplify-cli ↗

packageamplify-graphql-docs-generator ↗

homepagehttps://github.com/aws-amplify/amplify-cli#readme ↗