GithubHelp home page GithubHelp logo

enaqx / graphql-tools Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ardatan/graphql-tools

1.0 3.0 3.0 1.31 MB

:wrench: Build, mock, and stitch a GraphQL schema using the schema language

Home Page:

License: MIT License

TypeScript 100.00%

graphql-tools's Introduction

GraphQL-tools: generate and mock GraphQL.js schemas

npm version Build Status Coverage Status Get on Slack

This package provides a few useful ways to create a GraphQL schema:

  1. 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.
  2. Mock your GraphQL API with fine-grained per-type mocking
  3. Automatically stitch multiple schemas together into one larger API


Read the docs.

Binding to HTTP

If you want to bind your JavaScript GraphQL schema to an HTTP server, we recommend using Apollo Server, which supports every popular Node HTTP server library including Express, Koa, Hapi, and more.

JavaScript GraphQL servers are often developed with graphql-tools and apollo-server-express together: One to write the schema and resolver code, and the other to connect it to a web server.


See and edit the live example on Launchpad.

When using graphql-tools, you describe the schema as a GraphQL type language string:

const typeDefs = `
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 typeDefs;

Then 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: });
  Post: {
    author(post) {
      return find(authors, { id: post.authorId });

export default resolvers;

At the end, the schema and resolvers are combined using makeExecutableSchema:

import { makeExecutableSchema } from 'graphql-tools';

const executableSchema = makeExecutableSchema({

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 the schema section of the docs.


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!

graphql-tools's People


abernix avatar basst avatar benjamn avatar dxcx avatar enaqx avatar excitement-engineer avatar freiksenet avatar greenkeeper[bot] avatar greenkeeperio-bot avatar helfer avatar janat08 avatar kbrandwijk avatar loganpowell avatar lucasconstantino avatar martijnwalraven avatar mklopets avatar nicolaslopezj avatar nwfortner avatar oricordeau avatar renovate-bot avatar rricard avatar schickling avatar sebastienbarre avatar sethtippetts avatar slava avatar stegben avatar timmikeladze avatar timsuchanek avatar urigo avatar vladshcherbin avatar




 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.