apollo-server/packages/apollo-server-hapi/README.md

68 lines
2.5 KiB
Markdown
Raw Normal View History

---
title: Hapi
description: Setting up Apollo Server with Hapi
---
2016-10-23 01:17:37 -07:00
[![npm version](https://badge.fury.io/js/apollo-server-core.svg)](https://badge.fury.io/js/apollo-server-core) [![Build Status](https://travis-ci.org/apollographql/apollo-server.svg?branch=master)](https://travis-ci.org/apollographql/apollo-server) [![Coverage Status](https://coveralls.io/repos/github/apollographql/apollo-server/badge.svg?branch=master)](https://coveralls.io/github/apollographql/apollo-server?branch=master) [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://www.apollographql.com/#slack)
2017-06-28 23:50:29 -07:00
This is the Hapi integration of Apollo Server. Apollo Server is a community-maintained open-source Apollo Server that works with all Node.js HTTP server frameworks: Express, Connect, Hapi, Koa and Restify. [Read the docs](https://www.apollographql.com/docs/apollo-server/).
2017-06-28 23:50:29 -07:00
```sh
npm install apollo-server-hapi
```
2017-06-28 23:50:29 -07:00
## Usage
With the Hapi plugins `graphqlHapi` and `graphiqlHapi` you can pass a route object that includes options to be applied to the route. The example below enables CORS on the `/graphql` route.
The code below requires Hapi 17 or higher.
2017-06-28 23:50:29 -07:00
```js
import Hapi from 'hapi';
import { graphqlHapi } from 'apollo-server-hapi';
2017-06-28 23:50:29 -07:00
const HOST = 'localhost';
const PORT = 3000;
async function StartServer() {
const server = new Hapi.server({
host: HOST,
port: PORT,
});
2017-12-09 18:30:57 +05:30
await server.register({
plugin: graphqlHapi,
options: {
path: '/graphql',
graphqlOptions: {
schema: myGraphQLSchema,
},
route: {
cors: true,
},
},
});
try {
await server.start();
} catch (err) {
console.log(`Error while starting server: ${err.message}`);
2017-06-28 23:50:29 -07:00
}
2017-06-28 23:50:29 -07:00
console.log(`Server running at: ${server.info.uri}`);
}
StartServer();
2017-06-28 23:50:29 -07:00
```
## Principles
Apollo Server is built with the following principles in mind:
* **By the community, for the community**: Apollo Server's development is driven by the needs of developers
* **Simplicity**: by keeping things simple, Apollo Server is easier to use, easier to contribute to, and more secure
* **Performance**: Apollo Server is well-tested and production-ready - no modifications needed
Anyone is welcome to contribute to Apollo 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!