mirror of
https://github.com/vale981/apollo-server
synced 2025-03-06 10:11:40 -05:00
dbaa465646
* koa integration * use koa-bodyparser v3 for node 6 support * use middlewareFromPath instead of koa-router * use async/await in koa fileUploadMiddleware
52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
---
|
|
title: Koa
|
|
description: Setting up Apollo Server with Koa
|
|
---
|
|
|
|
[](https://badge.fury.io/js/apollo-server-koa) [](https://circleci.com/gh/apollographql/apollo-server) [](https://coveralls.io/github/apollographql/apollo-server?branch=master) [](https://www.apollographql.com/#slack)
|
|
|
|
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](https://www.apollographql.com/docs/apollo-server/). [Read the CHANGELOG.](https://github.com/apollographql/apollo-server/blob/master/CHANGELOG.md)
|
|
|
|
```sh
|
|
npm install apollo-server-koa@rc graphql
|
|
```
|
|
|
|
## Koa
|
|
|
|
```js
|
|
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](https://github.com/apollographql/apollo-server/blob/master/CONTRIBUTING.md), take a look at the [roadmap](https://github.com/apollographql/apollo-server/blob/master/ROADMAP.md) and make your first PR!
|