apollo-schema-extend
v0.3.0
Published
Extends your Apollo Server Express based graphql server with an external graphql source
Downloads
19
Maintainers
Readme
apollo-schema-extend
Extends your Apollo Server Express based graphql server with an external graphql source. Merges the external schema into the local schema and forwards any (parts of) request to be resolved by the external source. This library is intended for situations where Apollo Federation doesn't provide sufficient control or is not an option for other reasons.
Basic usage:
In this example myExternalSchema
is a GraphQLSchema
retrieved by using an IntrospectionQuery
and GqlDataSource
is a derived class of apollo-datasource-graphql
.
const withMyExternalSchema = withExternalSchema(myExternalSchema, {
dataSource: { name: 'external', factory: () => new GqlDataSource('https://myExternal.com/graphql') },
})
const apolloServer = new ApolloServer(withMyExternalSchema(localApolloServerConfig))
Recommended data source:
import { GraphQLDataSource } from 'apollo-datasource-graphql'
import { Context } from '...'
export class GqlDataSource extends GraphQLDataSource<Context> {
constructor(baseUrl: string) {
super()
this.baseURL = baseUrl
}
protected willSendRequest(request: any) {
// Add authorization header
}
}
Installation
Using npm:
$ npm install apollo-schema-extend
Using yarn:
$ yarn add apollo-schema-extend
Restrictions
The current version requires the apollo server config to contain the following fields:
- resolvers: must be
IResolvers<any, any>
(array is not supported) - typeDefs
- dataSources