Apollo Router quickstart
Run the Apollo Router with Apollo-hosted subgraphs
Hello! This tutorial walks you through installing the Apollo Router and running it in front of some Apollo-hosted example subgraphs.
Note: The Apollo Router is made available under the Elastic License v2.0 (ELv2). Read our licensing page for more details.
If you have a bash-compatible terminal, you can download the latest version of the Apollo Router directly to your current directory with the following command:
curl -sSL https://router.apollo.dev/download/nix/latest | sh
Go to the Apollo Router's GitHub Releases page and download the latest
.tar.gz file that matches your system. Currently, tarballs are available for the following:
- Linux (x86_64)
- macOS (x86_64)
- Windows (x86_64)
After downloading, extract the file by running the following from a new project directory, substituting the path to the tarball:
tar -xf path/to/file.tar.gz
You can now try running the Apollo Router from your project's root directory with the following command:
If you do, you'll get the following output:
APOLLO ROUTER <version>⚠️ The Apollo Router requires a composed supergraph schema at startup. ⚠️👉 DO ONE:* Pass a local schema file with the '--supergraph' option:$ ./router --supergraph <file_path>* Fetch a registered schema from Apollo Studio by settingthese environment variables:$ APOLLO_KEY="..." APOLLO_GRAPH_REF="..." ./routerFor details, see the Apollo docs:https://www.apollographql.com/docs/router/managed-federation/setup🔬 TESTING THINGS OUT?1. Download an example supergraph schema with Apollo-hosted subgraphs:$ curl -L https://supergraph.demo.starstuff.dev/ > starstuff.graphql2. Run the Apollo Router with the supergraph schema:$ ./router --supergraph starstuff.graphql
This is because Apollo Router requires a supergraph schema and we aren't providing it one! Let's fix that.
For this quickstart, we're using example Apollo-hosted subgraphs, along with an example supergraph schema that's composed from those subgraph schemas.
From your project's root directory, run the following:
curl -sSL https://supergraph.demo.starstuff.dev/ > supergraph-schema.graphql
This saves a
supergraph-schema.graphql file with the following contents:
This file is all that Apollo Router needs to communicate with our subgraphs!
Now from your project root, run the following:
./dist/router --supergraph supergraph-schema.graphql
The console output should look like the following:
2022-03-14T11:56:55.900207Z INFO apollo_router: Starting Apollo Router2022-03-14T11:56:56.000707Z INFO apollo_router: Listening on http://127.0.0.1:4000 🚀
That's it! Visit
http://127.0.0.1:4000 to open Apollo Sandbox. You can inspect the entire federated graph and run your first queries against the Apollo Router!
Now that you know how to run Apollo Router with a supergraph schema, you can: