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

58 lines
2.6 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://circleci.com/gh/apollographql/apollo-cache-control-js.svg?style=svg)](https://circleci.com/gh/apollographql/apollo-cache-control-js) [![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/). [Read the CHANGELOG.](https://github.com/apollographql/apollo-server/blob/master/CHANGELOG.md)
2017-06-28 23:50:29 -07:00
```sh
npm install apollo-server-hapi
```
2017-06-28 23:50:29 -07:00
## Usage
After constructing Apollo server, a hapi server can be enabled with a call to `registerServer`. Ensure that `autoListen` is set to false in the `Hapi.server` constructor.
2017-06-28 23:50:29 -07:00
The code below requires Hapi 17 or higher.
2017-06-28 23:50:29 -07:00
```js
const Hapi = require('hapi');
const { ApolloServer } = require('apollo-server');
const { registerServer } = require('apollo-server-hapi');
2017-06-28 23:50:29 -07:00
const HOST = 'localhost';
async function StartServer() {
const server = new ApolloServer({ typeDefs, resolvers });
//Note: autoListen is required, since Apollo Server will start the listener
const app = new Hapi.server({
autoListen: false,
host: HOST,
});
//apply other plugins
await registerServer({ server, app });
//port is optional and defaults to 4000
server.listen({ port: 4000 }).then(({ url }) => {
console.log(`🚀 Server ready at ${url}`);
});
}
StartServer().catch(error => console.log(e));
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!