🌍 GraphQL server for Express, Connect, Hapi, Koa and more
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci Add support for Jest JUnit test output for consumption by CircleCI. Sep 26, 2018
.github Update ISSUE_TEMPLATE.md Sep 27, 2018
.vscode Add TypeScript watch as default build task Oct 12, 2018
__mocks__ Fix `apollo-server-env` mock Oct 11, 2018
docs fixed arbitrarily (#1816) Oct 15, 2018
packages Export GraphQL request and reponse types from `apollo-server-plugin-b… Oct 15, 2018
types Add missing type dependencies for tests Oct 11, 2018
.gitignore Add support for Jest JUnit test output for consumption by CircleCI. Sep 26, 2018
.prettierignore Move prettier file globs into `.prettierrc.js` file. Sep 26, 2018
.prettierrc.js Move prettier file globs into `.prettierrc.js` file. Sep 26, 2018
CHANGELOG.md Pass the context request and response extension methods (#1547) Oct 10, 2018
CONTRIBUTING.md Tick off Prettier checkmarks, which were present on CI but not locall… Mar 16, 2018
DESIGN.md Tick off Prettier checkmarks, which were present on CI but not locall… Mar 16, 2018
LICENSE cherry-pick changes from master Jul 5, 2016
README.md Add Koa to the list of Apollo Server integrations (#1810) Oct 15, 2018
ROADMAP.md Setup prettier (#724) Jan 8, 2018
codecov.yml Add a Codecov configuration file to adjust the defaults. Oct 11, 2018
jest.config.base.js Add comments to `moduleNameMapper` option in Jest config Oct 12, 2018
lerna.json Clean up lerna.json Aug 31, 2018
netlify.toml Introduce a `netlify.toml` configuration to fix docs generation on Ne… Aug 28, 2018
package-lock.json chore(deps): update dependency multer to v1.4.1 Oct 13, 2018
package.json chore(deps): pin dependencies (#1809) Oct 15, 2018
renovate.json bring version-2 up to date Jul 13, 2018
tsconfig.base.json Enable `forceConsistentCasingInFileNames` in `tsconfig.base.json` Oct 11, 2018
tsconfig.build.json Remove test dependencies from non-test `tsconfig.json` files Oct 11, 2018
tsconfig.json Remove test dependencies from non-test `tsconfig.json` files Oct 11, 2018
tsconfig.test.base.json Expose global `fetch` and `URL` types to avoid relying on `dom` lib Oct 11, 2018
tsconfig.test.json Consistently leave out explicit `tsconfig.json` when referring to Typ… Oct 12, 2018

README.md

GraphQL Server for Express, Connect, Hapi, Cloudflare workers, and more

npm version Build Status Get on Slack

Apollo Server is a community-maintained open-source GraphQL server. It works with pretty much all Node.js HTTP server frameworks, and we're happy to take PRs for more! Apollo Server works with any GraphQL schema built with GraphQL.js, so you can build your schema with that directly or with a convenience library such as graphql-tools.

Documentation

Read the docs!

Principles

Apollo Server is built with the following principles in mind:

  • By the community, for the community: Apollo Server's development is driven by the needs of developers
  • Simplicity: by keeping things simple, Apollo Server is easier to use, easier to contribute to, and more secure
  • Performance: Apollo Server is well-tested and production-ready - no modifications needed

Anyone is welcome to contribute to Apollo Server, just read CONTRIBUTING.md, take a look at the roadmap and make your first PR!

Getting started

Apollo Server is super easy to set up. Just npm install apollo-server-<integration>, write a GraphQL schema, and then use one of the following snippets to get started. For more info, read the Apollo Server docs.

Installation

Run npm install --save apollo-server-<integration> and you're good to go!

const { ApolloServer, gql } = require('apollo-server');

// The GraphQL schema
const typeDefs = gql`
  type Query {
    "A simple type for getting started!"
    hello: String
  }
`;

// A map of functions which return data for the schema.
const resolvers = {
  Query: {
    hello: () => 'world',
  },
};

const server = new ApolloServer({
  typeDefs,
  resolvers,
});

While we recommend the use schema-definition language (SDL) for defining a GraphQL schema since we feel it's more human-readable and language-agnostic, Apollo Server can be configured with a GraphQLSchema object:

const { ApolloServer, gql } = require('apollo-server');
const { GraphQLSchema, GraphQLObjectType, GraphQLString } = require('graphql');

// The GraphQL schema
const schema = new GraphQLSchema({
  query: new GraphQLObjectType({
    name: 'Query',
    fields: {
      hello: {
        type: GraphQLString,
        description: 'A simple type for getting started!',
        resolve: () => 'world',
      },
    },
  }),
});

const server = new ApolloServer({ schema });

server.listen().then(({ url }) => {
  console.log(`🚀 Server ready at ${url}`);
});

Integrations

Often times, Apollo Server needs to be run with a particular integration. To start, run npm install --save apollo-server-<integration> where <integration> is one of the following:

  • express
  • koa
  • hapi
  • lambda
  • cloudflare

If a framework is not on this list and it should be supported, please open a PR.

Express

const express = require('express');
const { ApolloServer, gql } = require('apollo-server-express');

// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;

// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    hello: () => 'Hello world!',
  },
};

const server = new ApolloServer({ typeDefs, resolvers });

const app = express();
server.applyMiddleware({ app });

const port = 4000;

app.listen({ port }, () =>
  console.log(`🚀 Server ready at http://localhost:${port}${server.graphqlPath}`),
);

Connect

const connect = require('connect');
const { ApolloServer, gql } = require('apollo-server-express');
const query = require('qs-middleware');

// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;

// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    hello: () => 'Hello world!',
  },
};

const server = new ApolloServer({ typeDefs, resolvers });

const app = connect();
const path = '/graphql';

server.use(query());
server.applyMiddleware({ app, path });

const port = 4000;

app.listen({ port }, () =>
  console.log(`🚀 Server ready at http://localhost:${port}${server.graphqlPath}`),
);

Note; qs-middleware is only required if running outside of Meteor

Koa

const koa = require('koa');
const { ApolloServer, gql } = require('apollo-server-koa');

// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;

// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    hello: () => 'Hello world!',
  },
};

const server = new ApolloServer({ typeDefs, resolvers });

const app = new Koa();
server.applyMiddleware({ app });

const port = 3000;
const host = 'localhost';

app.listen(port, host, () =>
  console.log(`🚀 Server ready at http://${host}:${port}${server.graphqlPath}`),
);

Hapi

The code below requires Hapi 17 or higher.

const { ApolloServer, gql } = require('apollo-server-hapi');
const Hapi = require('hapi');

async function StartServer() {
  const server = new ApolloServer({ typeDefs, resolvers });

  const app = new Hapi.server({
    port: 4000,
  });

  await server.applyMiddleware({
    app,
  });

  await server.installSubscriptionHandlers(app.listener);

  await app.start();
}

StartServer().catch(error => console.log(error));

Context

The context is created for each request. The following code snippet shows the creation of a context. The arguments are the request, the request, and h, the response toolkit.

new ApolloServer({
  typeDefs,
  resolvers,
  context: async ({ request, h }) => {
    return { ... };
  },
})

AWS Lambda

Apollo Server can be run on Lambda and deployed with AWS Serverless Application Model (SAM). It requires an API Gateway with Lambda Proxy Integration.

const { ApolloServer, gql } = require('apollo-server-lambda');

// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;

// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    hello: () => 'Hello world!',
  },
};

const server = new ApolloServer({ typeDefs, resolvers });

exports.graphqlHandler = server.createHandler();

Apollo Server Development

If you want to develop Apollo Server locally you must follow the following instructions:

  • Fork this repository

  • Install the Apollo Server project in your computer

git clone https://github.com/[your-user]/apollo-server
cd apollo-server
npm install
cd packages/apollo-server-<integration>/
npm link
  • Install your local Apollo Server in other App
cd ~/myApp
npm link apollo-server-<integration>