apollo-server-integration-next

An Apollo Server integration for use with Next.js.

Versions

- If you're using Apollo Server 4.x use version 3.x
- If you're using Apollo Server 5.x use the latest version

Getting started

First create a Next.js API route by creating a file at for example pages/api/graphql.js.
This API route will be accessible at /api/graphql.

Next, create an Apollo Server instance and pass it to startServerAndCreateNextHandler:

``js
import { ApolloServer } from '@apollo/server';
import { startServerAndCreateNextHandler } from '@as-integrations/next';
import { gql } from 'graphql-tag';

const resolvers = {
Query: {
hello: () => 'world',
},
};

const typeDefs = gql
type Query {
hello: String
}
;

const server = new ApolloServer({
resolvers,
typeDefs,
});

export default startServerAndCreateNextHandler(server);
`

You may also pass a context function to startServerAndCreateNextHandler as such:

`js
export default startServerAndCreateNextHandler(server, {
context: async (req, res) => ({ req, res, user: await getLoggedInUser(req) }),
});
`

The Next.js req and res objects are passed along to the context function.

App Router (Route Handlers)

First create a Next.js Route Handler by creating a file at for example app/api/graphql/route.js.
This Route Handler will be accessible at /api/graphql.

Next, create an Apollo Server instance, pass it to startServerAndCreateNextHandler and
finally export the handler both as GET and POST:

`js
import { startServerAndCreateNextHandler } from '@as-integrations/next';
import { ApolloServer } from '@apollo/server';
import { gql } from 'graphql-tag';

const resolvers = {
Query: {
hello: () => 'world',
},
};

const typeDefs = gql
type Query {
hello: String
}
;

const server = new ApolloServer({
resolvers,
typeDefs,
});

const handler = startServerAndCreateNextHandler(server);

export { handler as GET, handler as POST };
`

TypeScript

When using this integration with Route Handlers you will have to specify the type of the incoming request object (Response or NextResponse) for the context function to receive the correct type signature:

`ts
import { NextRequest } from 'next/server';

// req has the type NextRequest
const handler = startServerAndCreateNextHandler(server, {
context: async req => ({ req }),
});
``