API Reference: expressMiddleware

This API reference documents Apollo Server 4's Express integration, the expressMiddleware function.

`expressMiddleware`

In the examples below, we use top-level await calls to start our server asynchronously. Check out our Getting Started guide to see how we configured our project to support this.

The expressMiddleware function enables you to attach Apollo Server to an Express server.

The expressMiddleware function expects you to set up HTTP body parsing and CORS headers for your web framework. Specifically, you should install the body-parser and cors packages and use them to set up your Express app, as shown below.

See Configuring CORS for guidance on configuring the CORS behavior of your project.

The expressMiddleware function accepts two arguments. The first required argument is an instance of ApolloServer that has been started:

1
import { ApolloServer } from '@apollo/server';
2
import { expressMiddleware } from '@apollo/server/express4';
3
import cors from 'cors';
4
import { json } from 'body-parser';
5
import express from 'express';
6

7
const app = express();
8

9
const server = new ApolloServer<MyContext>({
10
  typeDefs,
11
  resolvers,
12
});
13
// Note you must call `server.start()` on the `ApolloServer`
14
// instance before passing the instance to `expressMiddleware`
15
await server.start();
16

17
// Specify the path where we'd like to mount our server
18
app.use('/graphql', cors<cors.CorsRequest>(), json(), expressMiddleware(server));

1
import { ApolloServer } from '@apollo/server';
2
import { expressMiddleware } from '@apollo/server/express4';
3
import cors from 'cors';
4
import { json } from 'body-parser';
5
import express from 'express';
6

7
const app = express();
8

9
const server = new ApolloServer({
10
  typeDefs,
11
  resolvers,
12
});
13
// Note you must call `server.start()` on the `ApolloServer`
14
// instance before passing the instance to `expressMiddleware`
15
await server.start();
16

17
// Specify the path where we'd like to mount our server
18
app.use('/graphql', cors(), json(), expressMiddleware(server));
19

⚠️ To ensure your server gracefully shuts down, we recommend using the ApolloServerPluginDrainHttpServer plugin. See below for an example.

The expressMiddleware function's second optional argument is an object for configuring ApolloServer, which can contain the following options:

Name / Type	Description
`context` `Function`	An optional asynchronous `context` initialization function. The `context` function should return an object that all your server's resolvers share during an operation's execution. This enables resolvers to share helpful context values, such as a database connection. The `context` function receives `req` and `res` options which are `express.Request` and `express.Response` objects.

Example

Below is a full example of setting up expressMiddleware:

1
// npm install @apollo/server express graphql cors body-parser
2
import { ApolloServer } from '@apollo/server';
3
import { expressMiddleware } from '@apollo/server/express4';
4
import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
5
import express from 'express';
6
import http from 'http';
7
import cors from 'cors';
8
import bodyParser from 'body-parser';
9
import { typeDefs, resolvers } from './schema';
10

11
interface MyContext {
12
  token?: string;
13
}
14

15
// Required logic for integrating with Express
16
const app = express();
17
// Our httpServer handles incoming requests to our Express app.
18
// Below, we tell Apollo Server to "drain" this httpServer,
19
// enabling our servers to shut down gracefully.
20
const httpServer = http.createServer(app);
21

22
// Same ApolloServer initialization as before, plus the drain plugin
23
// for our httpServer.
24
const server = new ApolloServer<MyContext>({
25
  typeDefs,
26
  resolvers,
27
  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
28
});
29
// Ensure we wait for our server to start
30
await server.start();
31

32
// Set up our Express middleware to handle CORS, body parsing,
33
// and our expressMiddleware function.
34
app.use(
35
  '/',
36
  cors<cors.CorsRequest>(),
37
  bodyParser.json(),
38
  // expressMiddleware accepts the same arguments:
39
  // an Apollo Server instance and optional configuration options
40
  expressMiddleware(server, {
41
    context: async ({ req }) => ({ token: req.headers.token }),
42
  }),
43
);
44

45
// Modified server startup
46
await new Promise<void>((resolve) => httpServer.listen({ port: 4000 }, resolve));
47
console.log(`🚀 Server ready at http://localhost:4000/`);

1
// npm install @apollo/server express graphql cors body-parser
2
import { ApolloServer } from '@apollo/server';
3
import { expressMiddleware } from '@apollo/server/express4';
4
import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
5
import express from 'express';
6
import http from 'http';
7
import cors from 'cors';
8
import bodyParser from 'body-parser';
9
import { typeDefs, resolvers } from './schema';
10

11
// Required logic for integrating with Express
12
const app = express();
13
// Our httpServer handles incoming requests to our Express app.
14
// Below, we tell Apollo Server to "drain" this httpServer,
15
// enabling our servers to shut down gracefully.
16
const httpServer = http.createServer(app);
17

18
// Same ApolloServer initialization as before, plus the drain plugin
19
// for our httpServer.
20
const server = new ApolloServer({
21
  typeDefs,
22
  resolvers,
23
  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
24
});
25
// Ensure we wait for our server to start
26
await server.start();
27

28
// Set up our Express middleware to handle CORS, body parsing,
29
// and our expressMiddleware function.
30
app.use(
31
  '/',
32
  cors(),
33
  bodyParser.json(),
34
  // expressMiddleware accepts the same arguments:
35
  // an Apollo Server instance and optional configuration options
36
  expressMiddleware(server, {
37
    context: async ({ req }) => ({ token: req.headers.token }),
38
  }),
39
);
40

41
// Modified server startup
42
await new Promise((resolve) => httpServer.listen({ port: 4000 }, resolve));
43

44
console.log(`🚀 Server ready at http://localhost:4000/`);

startStandaloneServer

Overview