You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
If you want to bind your JavaScript GraphQL schema to an HTTP server, you can use
GraphQL Yoga .
You can develop your JavaScript based GraphQL API with graphql-tools and GraphQL Yoga 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:
consttypeDefs=/* 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 }`exportdefaulttypeDefs
Then you define resolvers as a nested object that maps type and field names to resolver functions:
constresolvers={Query: {posts(){returnposts}},Mutation: {upvotePost(_,{ postId }){constpost=find(posts,{id: postId})if(!post){thrownewError(`Couldn't find post with id ${postId}`)}post.votes+=1returnpost}},Author: {posts(author){returnfilter(posts,{authorId: author.id})}},Post: {author(post){returnfind(authors,{id: post.authorId})}}}exportdefaultresolvers
At the end, the schema and resolvers are combined using makeExecutableSchema:
GraphQL-Tools schema can be consumed by frameworks like GraphQL Yoga, Apollo GraphQL or
express-graphql For example in Node.js;
const{ createYoga }=require('graphql-yoga')const{ createServer }=require('http')constyoga=createYoga({schema: executableSchema})constserver=createServer(yoga)server.listen(4000,()=>{console.log('Yoga is listening at https://localhost:4000/graphql')})
You can check GraphQL Yoga for other JavaScript platforms and
frameworks besides vanilla Node.js HTTP.
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.