The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Docs

GraphQL Code Generator

Generate anything from GraphQL schema / operations!

Contact Us

Introspection

yarn add @graphql-codegen/introspection

This plugin generates a GraphQL introspection file based on your GraphQL schema.

Config API Reference#

minify

type: boolean default: false

Set to true in order to minify the JSON output.

Usage Examples#

generates: introspection.json: plugins: - introspection config: minify: true
descriptions

type: boolean default: true

Whether to include descriptions in the introspection result.

specifiedByUrl

type: boolean default: false

Whether to include specifiedByUrl in the introspection result.

directiveIsRepeatable

type: boolean default: true

Whether to include isRepeatable flag on directives.

schemaDescription

type: boolean default: false

Whether to include description field on schema.

federation

type: boolean

Package Details