@anvilco/apollo-server-plugin-introspection-metadata
A plugin for Apollo Server that allows for adding metadata to GraphQL Introspection Query responses.
Installation
Using npm:
npm install --save-prod @anvilco/apollo-server-plugin-introspection-metadata
Using yarn:
yarn add @anvilco/apollo-server-plugin-introspection-metadata
Usage
Consider 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'
const schemaMetadataByKind = {
OBJECT: {
MyType: {
metadata: {
foo: "bar",
baz: "bop",
}
fields: {
myField: {
metadata: {...}
args: {
myArg: {
metadata: {...}
}
}
}
}
},
MyOtherType: {...},
Query: {
fields: {
myQuery: {
metadata: {...}
args: {
myArg: {
metadata: {...}
}
}
}
}
},
Mutation: {
fields: {
myMutation: {
metadata: {...}
args: {
myArg: {
metadata: {...}
}
}
}
}
},
...
},
INPUT_OBJECT: {
...
},
SCALAR: {
...
},
ENUM: {
...
},
INTERFACE: {
...
},
}
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",
metadata: {...}
args: [{
name: "myArg",
metadata: {...}
}]
}]
},
{
kind: "OBJECT"
name: "Query"
fields: [{
name: "myQuery",
metadata: {...}
args: [{
name: "myArg",
metadata: {...}
}]
}]
},
{
kind: "OBJECT"
name: "Mutation"
fields: [{
name: "myMutation",
metadata: {...}
args: [{
name: "myArg",
metadata: {...}
}]
}]
},
]
}
}
}
API
generateApolloPlugin
(default
export)
This is what you most likely came here for. See Javadoc in index.js for more details.
addMetadata
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
isIntrospectionQuery
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.
REGEX_INTROSPECTION_QUERY
A Javascript RegEx that can be used to test a query string to determine if it's an Introspection Query or not.
References
Inspired from @cleartax/apollo-server-plugin-introspection-auth.