Docs
Launch GraphOS Studio
You're viewing documentation for a previous version of this software. Switch to the latest stable version.

Apollo Workbench

Overview


Apollo Workbench is a

that helps you design and reason about your organization's without writing any server code.

Currently, Workbench is especially useful for working on federated . Whether you're creating a new graph or making changes to an existing one, Workbench helps you understand how your graph composes throughout the design process.

Get started

Create graphs

Build graphs from scratch

Quickly create a new design and start adding :

Creating a Workbench design from scratch

Import graphs from Studio

After

, you can create local Workbench designs that are based on any Studio you have access to:

Creating a Workbench design from Studio

See

.

View supergraph and API schemas

As soon as you have a design that successfully composes, you can view its and :

Viewing a supergraph schema in Workbench

These schemas update as you make changes to your .

Create operations

Build operations from scratch

Workbench provides intelligent code completion to help you write against your design:

Creating a new operation in Workbench

Import operations from Studio

After

, you can import that have been executed against any you have access to:

Query plan view

See

.

View query plans

You can view the that the gateway uses to route each based on your :

Query plan view

Your design must compose successfully to be able to view details.

Debug your graph

See composition errors in-line

Any errors in your design are displayed in both the VS Code editor and the Problems panel. This helps you understand conflicts and resolve them before writing any server code for your :

In-line composition error info

Run locally with mocks

See

.

Export your designs

See

.


Ready to try it out? Continue to

.

Previous
Subgraph specification
Next
Setup
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company