https://github.com/SimonDegraeve/hapi-graphql

Create a GraphQL HTTP server with Hapi.
https://github.com/SimonDegraeve/hapi-graphql

Last synced: about 1 month ago
JSON representation

Create a GraphQL HTTP server with Hapi.

• Host: GitHub
• URL: https://github.com/SimonDegraeve/hapi-graphql
• Owner: SimonDegraeve
• Created: 2015-08-14T15:05:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-22T14:41:12.000Z (almost 7 years ago)
• Last Synced: 2024-10-11T09:39:33.412Z (2 months ago)
• Language: JavaScript
• Size: 40 KB
• Stars: 115
• Watchers: 4
• Forks: 27
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-graphql - hapi-graphql - Create a GraphQL HTTP server with Hapi. (Libraries / JavaScript Libraries)
• awesome-graphql - hapi-graphql - Create a GraphQL HTTP server with Hapi. (Implementations / JavaScript/TypeScript)
• awesome-graphql - hapi-graphql - Create a GraphQL HTTP server with Hapi. (Libraries / JavaScript Libraries)

README

        
# GraphQL Hapi Plugin

Create a GraphQL HTTP server with [Hapi](http://hapijs.com).

Port from [express-graphql](https://github.com/graphql/express-graphql).

```js

npm install --save hapi-graphql

```

### Example

```js

import Hapi from 'hapi';

import GraphQL from 'hapi-graphql';

import {GraphQLSchema} from 'graphql';

const server = new Hapi.Server();

server.connection({

  port: 3000

});

const TestSchema = new GraphQLSchema({});

server.register({

  register: GraphQL,

  options: {

    query: {

      # options, see below

    },

    // OR

    //

    // query: (request) => ({

    //   # options, see below

    // }),

    route: {

      path: '/graphql',

      config: {}

    }

  }

}, () =>

  server.start(() =>

    console.log('Server running at:', server.info.uri)

  )

);

```

### Options

The `options` key of `query` accepts the following:

  * **`schema`**: A `GraphQLSchema` instance from [`graphql-js`][].

    A `schema` *must* be provided.

  * **`context`**: A value to pass as the `context` to the `graphql()`

    function from [`graphql-js`][].

  * **`rootValue`**: A value to pass as the `rootValue` to the `graphql()`

    function from [`graphql-js`][].

  * **`pretty`**: If `true`, any JSON response will be pretty-printed.

  * **`formatError`**: An optional function which will be used to format any

    errors produced by fulfilling a GraphQL operation. If no function is

    provided, GraphQL's default spec-compliant [`formatError`][] function will

    be used.

  * **`validationRules`**: Optional additional validation rules queries must

    satisfy in addition to those defined by the GraphQL spec.

  * **`graphiql`**: If `true`, may present [GraphiQL][] when loaded directly

    from a browser (a useful tool for debugging and exploration).

#### Debugging

During development, it's useful to get more information from errors, such as

stack traces. Providing a function to `formatError` enables this:

```js

formatError: error => ({

  message: error.message,

  locations: error.locations,

  stack: error.stack

})

```