apollographql/apollo-server


🌍 GraphQL server for Express, Connect, Hapi, Koa and more

https://www.apollographql.com/docs/apollo-server/

License: MIT

Language: TypeScript

Keywords: apollographql, express, express-graphql, graphql, graphql-server, hapi, koa, node, restify


Apollo Server

GraphQL Server for Express, Koa, Hapi, Lambda, and more.

npm version Build Status Join the community on Spectrum

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 to add more! Apollo Server works with any GraphQL schema built with GraphQL.js--so you may build your schema with that or a convenience library such as graphql-tools.

Principles

Apollo Server is built with the following principles in mind:

  • By the community, for the community: Its development is driven by the needs of developers.
  • Simplicity: By keeping things simple, it is more secure and easier to implement and contribute.
  • Performance: It is well-tested and production-ready.

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

To get started with Apollo Server:

  • Install with npm install apollo-server-<integration>
  • Write a GraphQL schema
  • Use one of the following snippets

There are two ways to install Apollo Server:

  • Standalone: For applications that do not require an existing web framework, use the apollo-server package.
  • Integrations: For applications with a web framework (e.g. express, koa, hapi, etc.), use the appropriate Apollo Server integration package.

For more info, please refer to the Apollo Server docs.

Installation: Standalone

In a new project, install the apollo-server and graphql dependencies using:

npm install apollo-server graphql

Then, create an index.js which defines the schema and its functionality (i.e. resolvers):

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,
});

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

Due to its human-readability, we recommend using schema-definition language (SDL) to define a GraphQL schema--a GraphQLSchema object from graphql-js can also be specified instead of typeDefs and resolvers using the schema property:

const server = new ApolloServer({
  schema: ...
});

Finally, start the server using node index.js and go to the URL returned on the console.

For more details, check out the Apollo Server Getting Started guide and the fullstack tutorial.

For questions, the Apollo community on Spectrum.chat is a great place to get help.

Installation: Integrations

While the standalone installation above can be used without making a decision about which web framework to use, the Apollo Server integration packages are paired with specific web frameworks (e.g. Express, Koa, hapi).

The following web frameworks have Apollo Server integrations, and each of these linked integrations has its own installation instructions and examples on its package README.md:

Context

A request context is available for each request. When context is defined as a function, it will be called on each request and will receive an object containing a req property, which represents the request itself.

By returning an object from the context function, it will be available as the third positional parameter of the resolvers:

new ApolloServer({
  typeDefs,
  resolvers: {
    Query: {
      books: (parent, args, context, info) => {
        console.log(context.myProperty); // Will be `true`!
        return books;
      },
    }
  },
  context: async ({ req }) => {
    return {
      myProperty: true
    };
  },
})

Documentation

The Apollo Server documentation contains additional details on how to get started with GraphQL and Apollo Server.

The raw Markdown source of the documentation is available within the docs/ directory of this monorepo--to contribute, please use the Edit on GitHub buttons at the bottom of each page.

Development

If you wish to develop or contribute to Apollo Server, we suggest the following:

  • Fork this repository

  • Install the Apollo Server project on 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 the other App
cd ~/myApp
npm link apollo-server-<integration>

Community

Are you stuck? Want to contribute? Come visit us in the Apollo community on Spectrum.chat!

Maintainers

Project Statistics

Sourcerank 20
Repository Size 27.3 MB
Stars 8,600
Forks 1,137
Watchers 219
Open issues 258
Dependencies 3,732
Contributors 399
Tags 3,220
Created
Last updated
Last pushed

Top Contributors See all

Jesse Rosenberger renovate[bot] Renovate Bot Evans Hauser Martijn Walraven Jonas Helfer Hagai Cohen Sashko Stubailo Nick Nance David Glasser Trevor Blades Prosper Otemuyiwa James Baxley Aditya Pratap Singh Greenkeeper Jake Dawkins Uri Goldshtein Chang Wang greenkeeper[bot] Peggy Rayzis

Packages Referencing this Repo

apollo-server-openfaas
Production-ready Node.js GraphQL server for OpenFaas
Latest release 2.9.7 - Published - 8.6K stars
@apollo/server
Apollo Server
Latest release 3.0.0-alpha.1 - Updated - 8.6K stars
apollo-server-express-mod
Production-ready Node.js GraphQL server for Express and Connect
Latest release 2.9.5 - Updated - 8.6K stars
@magnus-plugins/apollo-server-fastify
Production-ready Node.js GraphQL server for Fastify
Latest release 1.2.1 - Updated - 8.6K stars
apollo-server-openwhisk
Production-ready Node.js GraphQL server for OpenWhisk Functions
Latest release 0.0.12 - Updated - 8.6K stars
apollo-server-uwebsockets-todel
Production-ready Node.js GraphQL server for uWebSockets.js
Latest release 2.4.8 - Published - 8.6K stars
apollo-server-uwebsockets
Production-ready Node.js GraphQL server for uWebSockets.js
Latest release 2.4.8 - Updated - 8.6K stars
apollo-server-hapi-coinstac
Production-ready Node.js GraphQL server for Hapi
Latest release 1.2.0 - Published - 8.6K stars
apollo-server-plugin-response-cache
Apollo Server full query response cache
Latest release 0.3.8 - Updated - 8.6K stars
traverse-apollo-server-micro
Production-ready Node.js GraphQL server for Micro
Latest release 2.3.2-alpha-1 - Published - 8.6K stars
traverse-apollo-server-core
Core engine for Apollo GraphQL server
Latest release 2.3.2-alpha-1 - Published - 8.6K stars
@capaj/apollo-server-express
Production-ready Node.js GraphQL server for Express and Connect
Latest release 2.2.0-alpha.3 - Updated - 8.6K stars
apollo-server-testing
Test utils for apollo-server
Latest release 2.9.13 - Updated - 8.6K stars
@reaktivo/apollo-server-cloud-functions
Production-ready Node.js GraphQL server for Google Cloud Functions
Latest release 2.0.0 - Published - 8.6K stars
@useful/apollo-server-kubeless
Production-ready Node.js GraphQL server for Kubeless
Latest release 2.0.0-beta.1.3 - Published - 8.6K stars
apollo-server-cloud-functions
Production-ready Node.js GraphQL server for Google Cloud Functions
Latest release 2.9.13 - Updated - 8.6K stars
apollo-server-cache-memcached
[![npm version](https://badge.fury.io/js/apollo-server-cache-memcached.svg)](https://badge.fury.i...
Latest release 0.6.3 - Updated - 8.6K stars
apollo-server-cache-redis
[![npm version](https://badge.fury.io/js/apollo-server-cache-redis.svg)](https://badge.fury.io/js...
Latest release 1.1.4 - Updated - 8.6K stars
apollo-datasource
🌍 GraphQL server for Express, Connect, Hapi, Koa and more
Latest release 2.0.0-rc.8 - Updated - 8.6K stars
apollo-server-errors
🌍 GraphQL server for Express, Connect, Hapi, Koa and more
Latest release 2.3.4 - Updated - 8.6K stars

Recent Tags See all

publish/20191205195400 December 05, 2019
apollo-server-testing@2.9.13 December 05, 2019
apollo-server-micro@2.9.13 December 05, 2019
apollo-server-lambda@2.9.13 December 05, 2019
apollo-server-koa@2.9.13 December 05, 2019
apollo-server-integration-testsuite@2.9.13 December 05, 2019
apollo-server-hapi@2.9.13 December 05, 2019
apollo-server-fastify@2.9.13 December 05, 2019
apollo-server-express@2.9.13 December 05, 2019
apollo-server-core@2.9.13 December 05, 2019
apollo-server-cloud-functions@2.9.13 December 05, 2019
apollo-server-cloudflare@2.9.13 December 05, 2019
apollo-server-azure-functions@2.9.13 December 05, 2019
apollo-server@2.9.13 December 05, 2019
@apollo/gateway@0.11.4 December 05, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-05-10 02:05:12 UTC

Login to resync this repository