Join us from October 8-10 in New York City to learn the latest tips, trends, and news about GraphQL federation and API platform engineering.Join us for GraphQL Summit 2024 in NYC
Start for Free
You're viewing documentation for a previous version of this software. Switch to the latest stable version.

Setting up Apollo Workbench

First, download the following required applications and :

  1. If you haven't yet, install VS Code.
  2. Install the Apollo GraphQL VS Code Extension.
    • This extension provides code completion when writing schemas and queries.
  3. Install the latest Apollo Workbench release.
    • You can view past releases here.

After you install the extension, it adds a Workbench icon to your VS Code Activity Bar:

Workbench in Activity Bar

The Workbench navigation panel is divided into three sections:

  • Local supergraph designs. This lists all of the .apollo-workbench files contained in the directory VS Code is opened to.
  • Apollo Studio graphs. This lists all of the you have access to in Apollo Studio. You can use this list to create a new design based on an existing graph.
  • Apollo Studio graph operations. This lists all of the associated with whichever Apollo Studio graph is selected.

Authenticating with Apollo Studio

Workbench can connect to Apollo Studio, enabling you to create designs based on your existing federated graphs. You can also push your local designs to Studio to create new graphs.

To log in to Studio from Workbench:

  1. Open VS Code to any folder.

  2. Go to your personal settings in Apollo Studio and obtain a personal API key.

  3. From the Workbench tab in VS Code, click Click here to login with your user api key. (You can also run the login command in the command palette.) Paste your API key into the input box:

Adding an API key to workbench

This saves the API key to your VS Code extension state.

Opening a folder in VS Code

You need to open a folder in VS Code to create designs in Workbench. Workbench uses this folder to store your designs.

Opening a folder in VS Code

Viewing logs

Apollo Workbench prints informative logs as you use it. To view the logs, select View > Output. Then in the Output panel, select Apollo Workbench from the dropdown menu in the upper right.

Creating a new graph
Rate articleRateEdit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy