Mercurius

Implement GraphQL servers and gateways with Fastify

GraphQL
mercurius-js/mercuriusmercurius.dev/mercurius

README

Mercurius Logo

mercurius


CI workflow

Mercurius is a [GraphQL](https://graphql.org/) adapter for [Fastify](https://www.fastify.io)

Features:

- Caching of query parsing and validation.
- Automatic loader integration to avoid 1 + N queries.
- Just-In-Time compiler via graphql-jit.
- Subscriptions.
- Federation support.
- Federated subscriptions support.
- Gateway implementation, including Subscriptions.
- Batched query support.
- Customisable persisted queries.

Docs


- Install
- Quick Start
- Examples
- API
- Context
- Loaders
- Hooks
- Lifecycle
- Federation
- Subscriptions
- Batched Queries
- Persisted Queries
- TypeScript Usage
- HTTP
- GraphQL over WebSocket
- Integrations
- Related Plugins
- Faq
- Acknowledgements
- License

Install


  1. ``` sh
  2. npm i fastify mercurius graphql
  3. # or
  4. yarn add fastify mercurius graphql
  5. ```

The previous name of this module was fastify-gql (< 6.0.0).

Quick Start


  1. ``` js
  2. 'use strict'

  4. const Fastify = require('fastify')
  5. const mercurius = require('mercurius')

  7. const app = Fastify()

  9. const schema = `
  10.   type Query {
  11.     add(x: Int, y: Int): Int
  12.   }
  13. `

  15. const resolvers = {
  16.   Query: {
  17.     add: async (_, { x, y }) => x + y
  18.   }
  19. }

  21. app.register(mercurius, {
  22.   schema,
  23.   resolvers
  24. })

  26. app.get('/', async function (req, reply) {
  27.   const query = '{ add(x: 2, y: 2) }'
  28.   return reply.graphql(query)
  29. })

  31. app.listen({ port: 3000 })
  32. ```

Examples


Check GitHub repo for more examples.

Acknowledgements


The project is kindly sponsored by:

- NearForm for Matteo's time in maintaining this module.

The Mercurius name was gracefully donated by Marco Castelluccio.
The usage of that library was described in https://hacks.mozilla.org/2015/12/web-push-notifications-from-irssi/, and
you can find that codebase in https://github.com/marco-c/mercurius.

License


MIT