apollo-server/packages/apollo-server-koa
Jesse Rosenberger 721c4c9b26
Remove dysfunctional coverall badges.
The coverage of various packages is now reported through codecov.io and can
be seen here: https://codecov.io/gh/apollographql/apollo-server/tree/master/packages
2019-02-26 12:12:25 +02:00
..
src apollo-server-koa: Respond to OPTIONS (#2288) 2019-02-19 18:01:17 +02:00
.npmignore Apollo Server 2 Koa integration (#1282) 2018-07-06 13:52:56 -07:00
jest.config.js Replace {} with Object.create(null) in jest.config.js 2018-10-12 13:00:13 +02:00
package.json Publish 2019-02-22 07:21:47 +00:00
README.md Remove dysfunctional coverall badges. 2019-02-26 12:12:25 +02:00
tsconfig.json Remove test dependencies from non-test tsconfig.json files 2018-10-11 12:58:03 +02:00

title description
Koa Setting up Apollo Server with Koa

npm version Build Status Join the community on Spectrum

This is the Koa integration of GraphQL Server. Apollo Server is a community-maintained open-source GraphQL server that works with many Node.js HTTP server frameworks. Read the docs. Read the CHANGELOG.

npm install apollo-server-koa graphql

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

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

Principles

GraphQL Server is built with the following principles in mind:

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

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