Launch Apollo Studio

Working with graphs

Publish and retrieve your API schema


These Rover commands are primarily for interacting with monolithic graphs that do not use federation. However, you can also use them to fetch a federated gateway's API schema from Apollo Studio or via introspection.

When interacting directly with a federated subgraph, instead use subgraph commands.

Fetching a schema

Fetching from Apollo Studio

This requires first authenticating Rover with Apollo Studio.

You can use Rover to fetch the current schema of any Studio graph and variant it has access to.

Run the graph fetch command, like so:

rover graph fetch my-graph@my-variant

The argument my-graph@my-variant in the example above specifies the ID of the Studio graph you're fetching from, along with which variant you're fetching.

You can omit @ and the variant name. If you do, Rover uses the default variant, named current.

Fetching via introspection

If you need to obtain the schema of a running GraphQL server or federated gateway, you can use Rover to execute an introspection query on it. This is especially helpful if you're developing a GraphQL server that doesn't define its schema via SDL, such as graphql-kotlin.

Use the graph introspect command, like so:

rover graph introspect http://example.com/graphql

The server must be reachable by Rover and it must have introspection enabled.

Including headers

If the endpoint you're trying to reach requires HTTP headers, you can use the --header (-H) flag to pass key:value pairs of headers. If you have multiple headers to pass, use the header multiple times. If the header includes any spaces, the pair must be quoted.

rover graph introspect http://example.com/graphql --header "Authorization: Bearer token329r"

Output format

By default, both graph fetch and graph introspect output fetched SDL to stdout. This is useful for providing the schema as input to other Rover commands:

rover graph introspect http://localhost:4000 | rover graph publish my-graph@dev --schema -

You can also save the output to a local .graphql file like so:

# Creates prod-schema.graphql or overwrites if it already exists
rover graph fetch my-graph@my-variant > prod-schema.graphql

For more on passing values via stdout, see Conventions.

Publishing a schema to Apollo Studio

This requires first authenticating Rover with Apollo Studio.

You can use Rover to publish schema changes to one of your Apollo Studio graphs.

Use the graph publish command, like so:

rover graph publish my-graph@my-variant --schema ./schema.graphql

The argument my-graph@my-variant in the example above specifies the ID of the Studio graph you're publishing to, along with which variant you're publishing to.

You can omit @ and the variant name. If you do, Rover publishes the schema to the default variant, named current.

If the graph exists in the graph registry, but the variant does not, a new variant will be created on publish.

Providing the schema

You provide your schema to Rover commands via the --schema option. The value is usually the path to a local .graphql or .gql file in SDL format.

If your schema isn't stored in a compatible file, you can provide - as the value of the --schema flag to instead accept an SDL string from stdin. This enables you to pipe the output of another Rover command (such as graph introspect), like so:

rover graph introspect http://localhost:4000 | rover graph publish my-graph@dev --schema -

Whenever possible, we recommend publishing a .graphql file directly instead of using introspection. An introspection result omits schema comments and most uses of directives.

For more on accepting input via stdin, see Conventions.

Checking schema changes

Schema checks require a paid plan.

Before you publish schema changes to Apollo Studio, you can check those changes to confirm that you aren't introducing breaking changes to your application clients.

To do so, you can run the graph check command:

# using a schema file
rover graph check my-graph@my-variant --schema ./schema.graphql

# using piped input to stdin
rover graph introspect http://localhost:4000 | rover graph check my-graph --schema -

As shown, arguments and options are similar to graph publish.

To configure the behavior of schema checks (such as the time range of past operations to check against), see the documentation for schema checks.

Deleting a variant

This requires first authenticating Rover with Apollo Studio.

You can delete a single variant of a graph by running rover graph delete:

# ⚠️ This action is irreversible!
rover graph delete my-graph@variant-to-delete

This command prompts you for confirmation because the action is irreversible. You can bypass confirmation by passing the --confirm flag.

If you delete a federated variant with this command, it also deletes all of that variant's subgraphs. To delete a single subgraph while preserving the variant, see Deleting a subgraph.

Edit on GitHub