mirror of
https://github.com/vale981/apollo-server
synced 2025-03-19 09:16:40 -04:00
42 lines
1.9 KiB
Markdown
42 lines
1.9 KiB
Markdown
# graphql-server-koa
|
|
|
|
[](https://badge.fury.io/js/graphql-server-core)
|
|
[](https://travis-ci.org/apollographql/graphql-server)
|
|
[](https://coveralls.io/github/apollographql/graphql-server?branch=master)
|
|
[](http://www.apollodata.com/#slack)
|
|
|
|
This is the Koa integration of GraphQL Server. GraphQL Server is a community-maintained open-source GraphQL server that works with all Node.js HTTP server frameworks: Express, Connect, Hapi, Koa and Restify. [Read the docs](http://dev.apollodata.com/tools/apollo-server/index.html).
|
|
|
|
## 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](./CONTRIBUTING.md), take a look at the [roadmap](./ROADMAP.md) and make your first PR!
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import koa from 'koa'; // koa@2
|
|
import koaRouter from 'koa-router'; // koa-router@next
|
|
import koaBody from 'koa-bodyparser'; // koa-bodyparser@next
|
|
import { graphqlKoa } from 'graphql-server-koa';
|
|
|
|
const app = new koa();
|
|
const router = new koaRouter();
|
|
const PORT = 3000;
|
|
|
|
// koaBody is needed just for POST.
|
|
app.use(koaBody());
|
|
|
|
router.post('/graphql', graphqlKoa({ schema: myGraphQLSchema }));
|
|
router.get('/graphql', graphqlKoa({ schema: myGraphQLSchema }));
|
|
|
|
app.use(router.routes());
|
|
app.use(router.allowedMethods());
|
|
app.listen(PORT);
|
|
```
|