This package provides a few useful ways to create a GraphQL schema:
- Use the GraphQL schema language to generate a schema with full support for resolvers, interfaces, unions, and custom scalars. The schema produced is completely compatible with GraphQL.js.
- Mock your GraphQL API with fine-grained per-type mocking
- Automatically stitch multiple schemas together into one larger API
Documentation
Binding to HTTP
If you want to bind your JavaScript GraphQL schema to an HTTP server, you can use express-graphql .
You can develop your JavaScript based GraphQL API with graphql-tools and express-graphql together: One to write the schema and resolver code, and the other to connect it to a web server.
Example
When using graphql-tools, you describe the schema as a GraphQL type language string:
const typeDefs = /* GraphQL */ `
type Author {
id: ID! # the ! means that every author object _must_ have an id
firstName: String
lastName: String
"""
the list of Posts by this author
"""
posts: [Post]
}
type Post {
id: ID!
title: String
author: Author
votes: Int
}
# the schema allows the following query:
type Query {
posts: [Post]
}
# this schema allows the following mutation:
type Mutation {
upvotePost(postId: ID!): Post
}
# we need to tell the server which types represent the root query
# and root mutation types. We call them RootQuery and RootMutation by convention.
schema {
query: Query
mutation: Mutation
}
`
export default typeDefsThen you define resolvers as a nested object that maps type and field names to resolver functions:
const resolvers = {
Query: {
posts() {
return posts
}
},
Mutation: {
upvotePost(_, { postId }) {
const post = find(posts, { id: postId })
if (!post) {
throw new Error(`Couldn't find post with id ${postId}`)
}
post.votes += 1
return post
}
},
Author: {
posts(author) {
return filter(posts, { authorId: author.id })
}
},
Post: {
author(post) {
return find(authors, { id: post.authorId })
}
}
}
export default resolversAt the end, the schema and resolvers are combined using makeExecutableSchema:
import { makeExecutableSchema } from '@graphql-tools/schema'
const executableSchema = makeExecutableSchema({
typeDefs,
resolvers
})GraphQL-Tools schema can be consumed by frameworks like Apollo GraphQL or express-graphql For example
const express = require('express')
const { graphqlHTTP } = require('express-graphql')
const app = express()
app.use(
'/graphql',
graphqlHTTP({
schema: executableSchema,
graphiql: true
})
)
app.listen(4000)
console.log('Running a GraphQL API server at http://localhost:4000/graphql')This example has the entire type definition in one string and all resolvers in one file, but you can combine types and resolvers from multiple files and objects, as documented in the modularizing type definitions and merging resolvers section of the docs.
Contributions
Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!
And if this is your first time contributing to this project, please do read our Contributor Workflow Guide before you get started off.
Code of Conduct
Help us keep GraphQL Tools open and inclusive. Please read and follow our Code of Conduct as adopted from Contributor Covenant