Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mercurius-js/mercurius
Implement GraphQL servers and gateways with Fastify
https://github.com/mercurius-js/mercurius
fastify federation gateway graphql hacktoberfest nodejs
Last synced: 3 days ago
JSON representation
Implement GraphQL servers and gateways with Fastify
- Host: GitHub
- URL: https://github.com/mercurius-js/mercurius
- Owner: mercurius-js
- License: mit
- Created: 2018-09-11T14:41:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T17:00:19.000Z (about 2 months ago)
- Last Synced: 2024-10-29T09:33:06.222Z (about 1 month ago)
- Topics: fastify, federation, gateway, graphql, hacktoberfest, nodejs
- Language: JavaScript
- Homepage: https://mercurius.dev/
- Size: 1.4 MB
- Stars: 2,350
- Watchers: 32
- Forks: 237
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- stars - mercurius-js/mercurius
- awesome-graphql - mercurius - GraphQL plugin for Fastify. (Implementations / JavaScript/TypeScript)
- awesome-list - mercurius - js | 1025 | (JavaScript)
README
# mercurius
[](https://github.com/mercurius-js/mercurius/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/mercurius)
[](https://www.npmjs.com/package/mercurius)
[](https://github.com/neostandard/neostandard)
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](http://npm.im/graphql-jit).
- Subscriptions.
- Federation support via [@mercuriusjs/federation](https://github.com/mercurius-js/mercurius-federation), including Subscriptions.
- Gateway implementation via [@mercuriusjs/gateway](https://github.com/mercurius-js/mercurius-gateway), including Subscriptions.
- Batched query support.
- Customisable persisted queries.
## Docs
- [Install](#install)
- [Quick Start](#quick-start)
- [Examples](#examples)
- [API](docs/api/options.md)
- [Context](docs/context.md)
- [Loaders](docs/loaders.md)
- [Hooks](docs/hooks.md)
- [Lifecycle](docs/lifecycle.md)
- [Federation](docs/federation.md)
- [Subscriptions](docs/subscriptions.md)
- [Batched Queries](docs/batched-queries.md)
- [Persisted Queries](docs/persisted-queries.md)
- [TypeScript Usage](/docs/typescript.md)
- [HTTP](/docs/http.md)
- [GraphQL over WebSocket](/docs/graphql-over-websocket.md)
- [Integrations](docs/integrations/)
- [Related Plugins](docs/plugins.md)
- [Faq](/docs/faq.md)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## Install
```bash
npm i fastify mercurius graphql
# or
yarn add fastify mercurius graphql
```
The previous name of this module was [fastify-gql](http://npm.im/fastify-gql) (< 6.0.0).
## Quick Start
```js
'use strict'
const Fastify = require('fastify')
const mercurius = require('mercurius')
const app = Fastify()
const schema = `
type Query {
add(x: Int, y: Int): Int
}
`
const resolvers = {
Query: {
add: async (_, { x, y }) => x + y
}
}
app.register(mercurius, {
schema,
resolvers
})
app.get('/', async function (req, reply) {
const query = '{ add(x: 2, y: 2) }'
return reply.graphql(query)
})
app.listen({ port: 3000 })
```
## Examples
Check [GitHub repo](https://github.com/mercurius-js/mercurius/tree/master/examples) for more examples.
## Acknowledgements
The project is kindly sponsored by:
- [NearForm](https://www.nearform.com)
- [Platformatic](https://platformatic.dev)
The Mercurius name was gracefully donated by [Marco Castelluccio](https://github.com/marco-c).
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