mirror of
https://github.com/vale981/apollo-server
synced 2025-03-10 13:06:39 -04:00
ebb36ad681
* Update suggested versions of dependencies for koa As koa@2 is now the norm, the master/latest releases of both koa-bodyparser and koa-router support koa@2. * Document Koa GraphiQL capabilities * Add link for passHeader reference in doc
67 lines
3 KiB
Markdown
67 lines
3 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](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!
|
||
|
||
## Usage
|
||
|
||
```js
|
||
import koa from 'koa'; // koa@2
|
||
import koaRouter from 'koa-router';
|
||
import koaBody from 'koa-bodyparser';
|
||
import { graphqlKoa } from 'apollo-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);
|
||
```
|
||
|
||
### GraphiQL
|
||
|
||
You can also use `apollo-server-koa` for hosting the [GraphiQL](https://github.com/graphql/graphiql) in-browser IDE. Note the difference between `graphqlKoa` and `graphiqlKoa`.
|
||
|
||
```js
|
||
import { graphiqlKoa } from 'apollo-server-koa';
|
||
|
||
// Setup the /graphiql route to show the GraphiQL UI
|
||
router.get('/graphiql', graphiqlKoa({
|
||
endpointURL: '/graphql' // a POST endpoint that GraphiQL will make the actual requests to
|
||
}));
|
||
```
|
||
|
||
In case your GraphQL endpoint is protected via authentication, or if you need to pass other custom headers in the request that GraphiQL makes, you can use the [`passHeader`](https://github.com/apollographql/apollo-server/blob/v1.0.2/packages/apollo-server-module-graphiql/src/renderGraphiQL.ts#L17) option – a string that will be added to the request header object.
|
||
|
||
For example:
|
||
```js
|
||
import { graphiqlKoa } from 'apollo-server-koa';
|
||
|
||
router.get('/graphiql', graphiqlKoa({
|
||
endpointURL: '/graphql',
|
||
passHeader: `'Authorization': 'Bearer lorem ipsum'`
|
||
}));
|
||
```
|