Quick start

Install

pnpm add graphql-yoga graphql

Start

Make a schema, create Yoga and start a Node server:

import { createServer } from 'node:http'
import { createSchema, createYoga } from 'graphql-yoga'

const yoga = createYoga({
  schema: createSchema({
    typeDefs: /* GraphQL */ `
      type Query {
        hello: String
      }
    `,
    resolvers: {
      Query: {
        hello: () => 'Hello from Yoga!'
      }
    }
  })
})

const server = createServer(yoga)

server.listen(4000, () => {
  console.info('Server is running on http://localhost:4000/graphql')
})

Overview

• undefinedEasiest way to run a GraphQL server: Sensible defaults & includes everything you need with
  minimal setup (we also export a platform/env-agnostic handler so you can build your own wrappers
  easily).
• undefinedIncludes Subscriptions: Built-in support for GraphQL subscriptions using
  undefinedServer-Sent Events.
• undefinedCompatible: Works with all GraphQL clients
  (Apollo, Relay,
  Urql…) and fits seamless in your GraphQL workflow.
• undefinedWHATWG Fetch API: the core package depends on
  WHATWG Fetch API so it can run and deploy on any environment
  (Serverless, Workers, Deno, Node).
• undefinedEasily Extendable: New GraphQL-Yoga support all envelop plugins.

Features

• Fully typed with TypeScript
• GraphQL over HTTP spec compliant
• GraphiQL included
• File uploads with GraphQL Multipart Request spec
• Subscriptions and realtime capabilities
• Automatic persisted queries
• Built-in parsing and validation caching
• Testing utilities
• Supports ESM
• Runs everywhere, including environments like:
  • Deno
  • Bun
  • Cloudflare Workers
  • AWS Lambda
  • And other…
• And more…

Documentation

Our documentation website will help you get
started.

Examples

We’ve made sure developers can quickly start with GraphQL Yoga by providing a comprehensive set of
examples.
See all of them in the examples/ folder.

Comparison

Read more about how GraphQL Yoga compares to other servers in the ecosystem
here.

Contributing

If this is your first time contributing to this project, please do read our
Contributor Workflow Guide
before you get started off.

For this project in particular, to get started on stage/2-failing-test:

1. Install Node.js
2. Run in your terminal: npm i -g pnpm@8 && pnpm install && pnpm build
3. Add tests to packages/graphql-yoga/__tests__ using Jest APIs
4. Run the tests with pnpm test

Feel free to open issues and pull requests. We’re always welcome support from the community.

Code of Conduct

Help us keep Yoga open and inclusive. Please read and follow our
Code of Conduct as adopted
from Contributor Covenant.

License

MIT