Static GraphQL Server Headers

This example shows what to do if your GraphQL server requires you to send static headers (such as basic auth or a token header) that are not user/session based.

Downloading the schema

Because downloading the schema happens during the module's initialisation, server options are not yet loaded.

For this reason, there are only limited possibilities to define headers for this request.

Header key and value must be provided directly in the configuration. Check out the full reference of the available configuration options for the urlSchemaOptions property.

import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  graphqlMiddleware: {
    graphqlEndpoint: 'https://api.example.com/graphql',

    codegenSchemaConfig: {
      urlSchemaOptions: {
        headers: {
          authentication: 'IBZxopckhZLalbbIzgp7VE0ae/+N0FAsA6D/31jDBuU=',
        },
      },
    },
  },
})

For query/mutation requests at runtime

Define a serverFetchOptions method in ~/server/graphqlMiddleware.serverOptions.ts. This method is called before a GraphQL request is made.

import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/server-options'
import { getHeader, createError } from 'h3'
import type { H3Event } from 'h3'
import type { FetchError } from 'ofetch'

export default defineGraphqlServerOptions({
  serverFetchOptions: function (event) {
    return {
      headers: {
        authentication: 'IBZxopckhZLalbbIzgp7VE0ae/+N0FAsA6D/31jDBuU=',
      },
    }
  },
})