API Reference: startStandaloneServer

This API reference documents the startStandaloneServer function.

Overview

This startStandaloneServer function helps you get started with Apollo Server quickly. This function is recommended for all projects that don't require serverless support or a particular Node.js framework (such as Fastify). Under the hood, the startStandaloneServer function uses Apollo Server 4's Express integration (i.e., expressMiddleware).

Because it sets helpful defaults, this function is less configurable than other Apollo Server integrations. Complex projects might eventually need to swap to using expressMiddleware (this process is straightforward).

`startStandaloneServer`

ⓘ NOTE

In the examples below, we use top-level await calls to start our server asynchronously. If you'd like to see how we set this up, check out the Getting Started guide for details.

The startStandaloneServer function accepts two arguments. The first required argument is the instance of ApolloServer to begin listening for incoming requests:

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3

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

6
// `startStandaloneServer` returns a `Promise` with the
7
// the URL that the server is listening on.
8
 const { url } = await startStandaloneServer(server);

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3

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

6
// `startStandaloneServer` returns a `Promise` with the
7
// the URL that the server is listening on.
8
 const { url } = await startStandaloneServer(server);

The startStandaloneServer function's second optional argument is an object for configuring your server's options, which can contain the following properties:

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 `http.IncomingMessage` and `http.ServerResponse` types.
`listen` `Object`	An optional `listen` configuration object. The `listen` option accepts an object with the same properties as the `net.Server.listen` options object. If no `port` is specified, this defaults to using `{port: 4000}`.

Example

Below is a full example of setting up startStandaloneServer:

1
// npm install @apollo/server graphql
2
import { ApolloServer } from '@apollo/server';
3
import { startStandaloneServer } from '@apollo/server/standalone';
4
import { typeDefs, resolvers } from './schema';
5

6
interface MyContext {
7
  token?: String;
8
}
9

10
const server = new ApolloServer<MyContext>({ typeDefs, resolvers });
11
const { url } = await startStandaloneServer(server, {
12
  context: async ({ req }) => ({ token: req.headers.token }),
13
  listen: { port: 4000 },
14
});
15
console.log(`🚀  Server ready at ${url}`);

1
// npm install @apollo/server graphql
2
import { ApolloServer } from '@apollo/server';
3
import { startStandaloneServer } from '@apollo/server/standalone';
4
import { typeDefs, resolvers } from './schema';
5

6
const server = new ApolloServer({ typeDefs, resolvers });
7
const { url } = await startStandaloneServer(server, {
8
  context: async ({ req }) => ({ token: req.headers.token }),
9
  listen: { port: 4000 },
10
});
11
console.log(`🚀  Server ready at ${url}`);

Swapping to `expressMiddleware`

The startStandaloneServer function is not right for every use case, particularly if you need to customize your server's behavior. For example, you might want to customize your CORS behavior, run some middleware before processing GraphQL requests, or serve other endpoints from the same server.

In these cases, we recommend you swap out startStandaloneServer for expressMiddleware (unless you are confident that you want to use a different Node.js framework). This change requires only a few lines and has a minimal effect on your server's existing behavior (startStandaloneServer uses expressMiddleware under the hood).

We recommend Express because it's the most popular Node.js web framework, and it integrates well with many other popular libraries. It does have its limitations (for example, Express async support is not built around Promises and async functions), but backward incompatible changes to the framework are rarer than in newer libraries.

Example

Let's say our current startStandaloneServer setup uses the following code:

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3
import { typeDefs, resolvers } from './schema';
4

5
interface MyContext {
6
  token?: String;
7
}
8

9
const server = new ApolloServer<MyContext>({ typeDefs, resolvers });
10
const { url } = await startStandaloneServer(server, {
11
  context: async ({ req }) => ({ token: req.headers.token }),
12
  listen: { port: 4000 },
13
});
14
console.log(`🚀  Server ready at ${url}`);

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3
import { typeDefs, resolvers } from './schema';
4

5
const server = new ApolloServer({ typeDefs, resolvers });
6
const { url } = await startStandaloneServer(server, {
7
  context: async ({ req }) => ({ token: req.headers.token }),
8
  listen: { port: 4000 },
9
});
10
console.log(`🚀  Server ready at ${url}`);

To swap to using expressMiddleware, you'll first need to install the following packages so you'll be able to set up CORS for your server:

1
npm install express cors

Next, we can modify our code to match the following:

1
// npm install @apollo/server express graphql cors
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 { typeDefs, resolvers } from './schema';
9

10
interface MyContext {
11
  token?: String;
12
}
13

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

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

31
// Set up our Express middleware to handle CORS, body parsing,
32
// and our expressMiddleware function.
33
app.use(
34
  '/',
35
  cors<cors.CorsRequest>(),
36
  // 50mb is the limit that `startStandaloneServer` uses, but you may configure this to suit your needs
37
  express.json({ limit: '50mb' }),
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
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 { typeDefs, resolvers } from './schema';
9

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

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

27
// Set up our Express middleware to handle CORS, body parsing,
28
// and our expressMiddleware function.
29
app.use(
30
  '/',
31
  cors(),
32
  // 50mb is the limit that `startStandaloneServer` uses, but you may configure this to suit your needs
33
  express.json({ limit: '50mb' }),
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
console.log(`🚀 Server ready at http://localhost:4000/`);

ApolloServer

expressMiddleware

API Reference: startStandaloneServer

Overview

`startStandaloneServer`

Options

`context`

`listen`

Example

Swapping to `expressMiddleware`

Example

API Reference: startStandaloneServer

startStandaloneServer

Options

context

listen

Example

Swapping to expressMiddleware

Example

`startStandaloneServer`

`context`

`listen`

Swapping to `expressMiddleware`