GraphQL Yoga

Category

Complete guide to using GraphQL Yoga with Nitro GraphQL.

What is GraphQL Yoga?

GraphQL Yoga is a modern, batteries-included GraphQL server with:

• Smaller bundle size
• Better performance
• Built-in features (file uploads, subscriptions)
• Simple configuration

Installation

pnpm add nitro-graphql@beta graphql-yoga graphql graphql-config

Configuration

// nitro.config.ts
import graphql from 'nitro-graphql'
import { defineNitroConfig } from 'nitro/config'

export default defineNitroConfig({
  modules: [
    graphql({
      framework: 'graphql-yoga',
    }),
  ],
})

Features

Automatic Playground

Access at http://localhost:3000/api/graphql

File Uploads

Supported out of the box:

scalar Upload

type Mutation {
  uploadFile(file: Upload!): File!
}

Subscriptions

WebSocket subscriptions included:

import { defineSubscription } from 'nitro-graphql/define'

export const messageSubscriptions = defineSubscription({
  messageAdded: {
    subscribe: (_, __, { pubsub }) => pubsub.asyncIterator(['MESSAGE_ADDED']),
  },
})

Custom Configuration

// server/graphql/config.ts
import { defineGraphQLConfig } from 'nitro-graphql/define'

export default defineGraphQLConfig({
  plugins: [
    // Add custom plugins
  ],
  maskedErrors: process.env.NODE_ENV === 'production',
})

Next Steps

• Apollo Server - Alternative framework
• Framework Comparison
• Configuration Reference

---

Source

Contributors

productdevbook alexanderop

Changelog

26362refactor: rename defineType to defineField across documentation and examples

0.2.0 on