A plugin for Apollo Server that allows for adding metadata to GraphQL Introspection Query responses.
Using npm:
npm install --save-prod @anvilco/apollo-server-plugin-introspection-metadataUsing yarn:
yarn add @anvilco/apollo-server-plugin-introspection-metadataConsider the following example GraphQL SDL:
type MyType { myField( myArg: String ): String } type Query { myQuery( myArg: String ): String } type Mutation { myMutation( myArg: String ): String } interface MyInterface { id: ID } enum MyEnum { ONE TWO THREE } When instantiating ApolloServer, pass the following options:
import { ApolloServer } = from 'apollo-server' import IntrospectionMetadataPlugin from '@anvilco/apollo-server-plugin-introspection-metadata' // All keys are optional, all the way down the object. // Only build/include what you want to add metadata for :) const schemaMetadataByKind = { // Metadata for things of the kind "OBJECT" OBJECT: { MyType: { // Arbitrary metadata about the MyType Object metadata: { foo: "bar", baz: "bop", } fields: { myField: { // Arbitrary metadata about the myField Field metadata: {...} args: { myArg: { // Arbitrary metadata about the myArg Argument metadata: {...} } } } } }, MyOtherType: {...}, Query: { // Queries you've defined end up as Fields in the Queries Type, so this // structure follows that pattern fields: { myQuery: { // Arbitrary metadata about the myQuery Query metadata: {...} args: { myArg: { // Arbitrary metadata about the myArg Argument metadata: {...} } } } } }, Mutation: { // Mutations you've defined end up as Fields in the Mutation Type, so // this structure follows that pattern fields: { myMutation: { // Arbitrary metadata about the myMutation Mutation metadata: {...} args: { myArg: { // Arbitrary metadata about the myArg Argument metadata: {...} } } } } }, ... }, // Metadata for things of the kind "INPUT_OBJECT" INPUT_OBJECT: { ... }, // Metadata for things of the kind "SCALAR" SCALAR: { ... }, // Metadata for things of the kind "ENUM" ENUM: { ... }, // Metadata for things of the kind "INTERFACE" INTERFACE: { ... }, } // If you want to only add this metadata in the Development // environment: const apolloPlugins = []; if (process.env.NODE_ENV === 'development') { apolloPlugins.push( IntrospectionMetadataPlugin({ schemaMetadata: schemaMetadataByKind }) ) } const apolloServer = new ApolloServer({ //... introspection: true, plugins: apolloPlugins, //... })Output of the Intropection Query will the become something like this:
{ data: { __schema: { //... types: [ { kind: "OBJECT" name: "MyType" metadata: { foo: "bar", baz: "bop", }, fields: [{ //... name: "myField", // myField metadata metadata: {...} args: [{ //... name: "myArg", // myField's myArg metadata metadata: {...} }] }] }, { kind: "OBJECT" name: "Query" fields: [{ //... name: "myQuery", // myQuery metadata metadata: {...} args: [{ //... name: "myArg", // myQuery's myArg metadata metadata: {...} }] }] }, { kind: "OBJECT" name: "Mutation" fields: [{ //... name: "myMutation", // myMutation metadata metadata: {...} args: [{ //... name: "myArg", // myMutation's myArg metadata metadata: {...} }] }] }, //... ] } } }This is what you most likely came here for. See Javadoc in index.js for more details.
If you're not actually using Apollo Server, or want to augment an Introspection Query response from somewhere else with your metadata, then this function may be what you're looking for. See Javadoc in index.js
A function that takes the Apollo context as an argument and returns a Boolean indicating whether it appears to be an Introspection Query or not. Useful if you're considering implementing your own testFn to provide to the generateApolloPlugin call.
A Javascript RegEx that can be used to test a query string to determine if it's an Introspection Query or not.
Inspired from @cleartax/apollo-server-plugin-introspection-auth.