⚠️

Warning

This is the documentation for the old GraphQL Yoga v3.
We recommend upgrading to the latest GraphQL Yoga v5. Migrate to GraphQL Yoga v5.

Quick start

GraphQL Yoga is a batteries-included cross-platform GraphQL over HTTP spec-compliant GraphQL server powered by Envelop and GraphQL Tools that runs anywhere; focused on easy setup, performance and great developer experience.

Installation

Terminal


yarn add graphql graphql-yoga

Terminal


npm install graphql graphql-yoga

Terminal


pnpm add graphql graphql-yoga

Schema

You will need to provide a schema to Yoga, there are many ways to assemble a GraphQL schema, here’s just a few:

Use the createSchema function included in Yoga. It actually reuses the makeExecutableSchema from @graphql-tools/schema.

schema.js


import { createSchema } from 'graphql-yoga'
 
export const schema = createSchema({
  typeDefs: /* GraphQL */ `
    type Query {
      hello: String
    }
  `,
  resolvers: {
    Query: {
      hello: () => 'world'
    }
  }
})

💡

Tip

Get the best developer experience!

GraphQL Code Generator and its server preset can help you build type-safe and scalable GraphQL servers.

Check out GraphQL Code Generator , then read how to set up GraphQL server with server preset .

makeExecutableSchema from @graphql-tools/schema is very simple, but powerful. Install it and create a schema.

Terminal


yarn add @graphql-tools/schema

Terminal


npm install @graphql-tools/schema

Terminal


pnpm add @graphql-tools/schema

schema.js


import { makeExecutableSchema } from '@graphql-tools/schema'
 
export const schema = makeExecutableSchema({
  typeDefs: /* GraphQL */ `
    type Query {
      hello: String
    }
  `,
  resolvers: {
    Query: {
      hello: () => 'world'
    }
  }
})

💡

Tip

Get the best developer experience!

GraphQL Code Generator and its server preset can help you build type-safe and scalable GraphQL servers.

Check out GraphQL Code Generator , then read how to set up GraphQL server with server preset .

Pothos is a plugin based GraphQL schema builder for TypeScript. Install it and create a schema.

Terminal


yarn add @pothos/core

Terminal


npm install @pothos/core

Terminal


pnpm add @pothos/core

schema.js


import SchemaBuilder from '@pothos/core'
 
const builder = new SchemaBuilder({})
 
builder.queryType({
  fields: (t) => ({
    hello: t.string({
      resolve: () => 'world'
    })
  })
})
 
export const schema = builder.toSchema()

Declarative, Code-First GraphQL Schemas for JavaScript/TypeScript through Nexus GraphQL . Install it and create schema.

Terminal


yarn add nexus

Terminal


npm install nexus

Terminal


pnpm add nexus

schema.js


import { makeSchema, queryField } from 'nexus'
 
const helloField = queryField('hello', {
  type: 'String',
  resolve: () => 'world'
})
 
export const schema = makeSchema({ types: [helloField] })

Code-first type-safe GraphQL schema without codegen or metaprogramming using gqtx . Install it and create schema.

Terminal


yarn add gqtx

Terminal


npm install gqtx

Terminal


pnpm add gqtx

schema.js


import { createTypesFactory, buildGraphQLSchema } from 'gqtx'
 
const t = createTypesFactory()
 
const Query = t.queryType({
  fields: () => [
    t.field({
      name: 'hello',
      type: t.String,
      resolve: () => 'world'
    })
  ]
})
 
export const schema = buildGraphQLSchema({ query: Query })

graphql-js is a reference implementation of GraphQL for JavaScript. You should already have it installed, just create schema.

schema.js


import { GraphQLSchema, GraphQLObjectType, GraphQLString } from 'graphql'
 
export const schema = new GraphQLSchema({
  query: new GraphQLObjectType({
    name: 'Query',
    fields: {
      hello: {
        type: GraphQLString,
        resolve: () => 'world'
      }
    }
  })
})

Server

After you have created a GraphQL schema, simply pass it in to Yoga and liftoff! 🚀


import { createServer } from 'node:http'
import { createYoga } from 'graphql-yoga'
import { schema } from './schema'
 
// Create a Yoga instance with a GraphQL schema.
const yoga = createYoga({ schema })
 
// Pass it into a server to hook into request handlers.
const server = createServer(yoga)
 
// Start the server and you're done!
server.listen(4000, () => {
  console.info('Server is running on http://localhost:4000/graphql')
})

Visit http://localhost:4000/graphql to see Yoga in action.