nuxt-graphql-server
TypeScript icon, indicating that this package has built-in type declarations

3.1.4 • Public • Published

GraphQL Server Toolkit for Nuxt

npm version npm downloads Github Actions Codecov

This package allows you to easily develop a GraphQL server in your Nuxt 3 application.

For consuming a GraphQL API on the client-side, we recommend the modules Nuxt Apollo, Nuxt GraphQL Client or nuxt/graphql-client.

Features

  • Provides a virtual module #graphql/schema from where you can import your schema. Under the hood, it automatically merges multiple schema files together into a complete schema. Moreover, you no longer need to worry about deploying schema graphql files.
  • Automatically generated typescript definitions for your resolvers via the virtual module #graphql/resolver.
  • Support for GraphQL subscriptions.
  • Nuxt Devtools integration: adds the Apollo Studio Sandbox directly in the devtools.

Installation

# nuxi
npx nuxi@latest module add graphql-server

# npm
npm install @apollo/server graphql @as-integrations/h3 nuxt-graphql-server

# yarn
yarn add @apollo/server graphql @as-integrations/h3 nuxt-graphql-server

# pnpm
pnpm add @apollo/server graphql @as-integrations/h3 nuxt-graphql-server

Usage

  1. If not using nuxi for the installation, add the module in nuxt.config.ts:

    export default defineNuxtConfig({
      modules: ['nuxt-graphql-server'],
      // Optional top-level config
      graphqlServer: {
        // config
      },
    })
    
    // or
    
    export default defineNuxtConfig({
      modules: [
        [
          'nuxt-graphql-server',
          {
            /* Optional inline config */
          },
        ],
      ],
    })
  2. Define the GraphQL schema in .graphql files located in the server folder.

  3. Expose the GraphQL API endpoint by creating server/api/graphql.ts with the following content:

    import { Resolvers } from '#graphql/resolver'
    import { typeDefs } from '#graphql/schema'
    import { ApolloServer } from '@apollo/server'
    import { startServerAndCreateH3Handler } from '@as-integrations/h3'
    
    const resolvers: Resolvers = {
      Query: {
        // Typed resolvers
      },
    }
    
    const apollo = new ApolloServer({ typeDefs, resolvers })
    
    export default startServerAndCreateH3Handler(apollo, {
      // Optional: Specify context
      context: (event) => {
        /*...*/
      },
    })
  4. Optionally, specify the (relative) url to the GraphQL endpoint in nuxt.config.ts to enable the Nuxt Devtools integration.

    graphqlServer: {
       url: '/api/graphql',
    }

Subscriptions

To enable subscriptions, you need to install a few more dependencies:

# npm
npm install graphql-ws graphql-subscriptions

# yarn
yarn add graphql-ws graphql-subscriptions

# pnpm
pnpm add graphql-ws graphql-subscriptions

The package graphql-ws is a lightweight WebSocket server that can be used to handle GraphQL subscriptions. The package graphql-subscriptions provides the PubSub class that can be used to publish and subscribe to events.

Note that the default PubSub implementation is intended for demo purposes. It only works if you have a single instance of your server and doesn't scale beyond a couple of connections. For production usage you'll want to use one of the PubSub implementations backed by an external store. (e.g. Redis).

Activate websocket support in your nuxt.config.ts:

nitro: {
  experimental: {
    websocket: true,
  },
},

Then, create the endpoint server/api/graphql.ts with the following content:

import { ApolloServer } from '@apollo/server'
import {
  startServerAndCreateH3Handler,
  defineGraphqlWebSocket,
} from '@as-integrations/h3'
import { makeExecutableSchema } from '@graphql-tools/schema'
import type { Resolvers } from '#graphql/resolver'
import { typeDefs } from '#graphql/schema'

const resolvers: Resolvers = {
  Query: {
    // Typed resolvers
  },
  Subscription: {
    // Typed resolvers
  },
}

const schema = makeExecutableSchema({ typeDefs, resolvers })
const apollo = new ApolloServer({ schema })
export default startServerAndCreateH3Handler(apollo, {
  websocket: defineGraphqlWebSocket({ schema }),
})

A full example can be found in the playground folder under server/api/subscription.ts.

Options

graphqlServer: {
  url: '/relative/path/to/your/graphql/endpoint',
  schema: './server/**/*.graphql',
  codegen: {
    maybeValue: T | null | undefined
  }
}

url

Relative url to your GraphQL Endpoint to enable the Nuxt Devtools integration.

schema

A glob pattern on how to locate your GraphQL Schema (.graphql) files.

Default: './server/**/*.graphql'

codegen

This module uses GraphQL Code Generator under the hood and makes use of the TypeScript and TypeScript Resolvers plugins which means any options from those plugins can be passed here based on your needs.

For example, you may want to:

export default defineNuxtConfig({
  modules: ['nuxt-graphql-server'],

  graphqlServer: {
    codegen: {
      // Map your internal enum values to your GraphQL's enums.
      enumValues: '~/graphql/enums/index',

      // Make use of your custom GraphQL Context type and let codegen use it so that the
      // generated resolvers automatically makes use of it.
      contextType: '~/server/graphql/GraphQLContext#GraphQLContext',

      // Change the naming convention of your enum keys
      namingConvention: {
        enumValues: 'change-case-all#constantCase',
      },

      // ... and many more, refer to the plugin docs!
    },
  },
})

💻 Development

  • Clone this repository
  • Enable Corepack using corepack enable (use npm i -g corepack for Node.js < 16.10).
  • Install dependencies using pnpm install.
  • Run pnpm dev:prepare to generate type stubs.
  • Use pnpm dev to start playground in development mode.

License

Made with 💛

Published under MIT License.

Readme

Keywords

none

Package Sidebar

Install

npm i nuxt-graphql-server

Weekly Downloads

354

Version

3.1.4

License

MIT

Unpacked Size

17 kB

Total Files

11

Last publish

Collaborators

  • tobiasdiez