Docs
Launch GraphOS Studio

Routing for supergraphs

Learn about self-hosted and cloud routing options


With architecture (also known as

), each component service is known as a subgraph. A router acts as an entry point to your and provides a unified interface for clients to interact with. Clients send to your 's public endpoint instead of directly to your APIs.

Clients
Router
Subgraph A
Subgraph B

The router intelligently executes each incoming client across the appropriate combination of subgraphs. It then merges subgraph responses into a single response for the client. You can configure your router's error handling, CORS settings, other security features, and more. Your configuration options depend on your router type.

GraphOS router types

With , you can you can choose for Apollo to provision and manage a cloud-hosted router for you:

Your infrastructure
Apollo Cloud
Subgraph A
Subgraph B
Router
Clients

Or you can choose to self-host your router:

Your infrastructure
Router
Subgraph A
Subgraph B
Clients

Cloud and are both powered by the —a high-performance routing runtime packaged as a

.

NOTE

Apollo also offers the

@apollo/gateway
library, but we recommend the Apollo Router over @apollo/gateway because it provides
significant performance and security improvements
. For more information about the differences and how to migrate, see the
migration guide
.

Router comparison

Apollo offers the following router options, in increasing order of configurability:

Router typeDescriptionConfigurabilityPlan availability
Shared cloud routerApollo provisions and manages routers on shared infrastructure.Basic configurability, including HTTP header rules, CORS settings, and subgraph error inclusion
Serverless
Dedicated cloud routerApollo provisions and manages routers on dedicated infrastructure that you control and scale.Highly configurable, including all options for shared cloud routers and additional configurations
Dedicated
Self-hosted routerYou host and manage the router on your own infrastructure.Highly configurable and customizable, including all options for Cloud Dedicated routers and additional
customization options
Apollo Router is available as a free and source-available runtime. Connecting your self-hosted router to GraphOS requires an
Enterprise
plan.

GraphOS router features

Although all (both cloud- and self-hosted) are powered by the source-available Apollo Router binary, they offer an expanded feature set that isn't available when running the Apollo Router without connecting it to GraphOS.

Cloud-hosted automatically have access to additional features, while self-hosted routers must be authenticated with a GraphOS to gain access to these features. Refer to the

to compare GraphOS router features across plan types.

Setup and configuration

For setup and configuration instructions, refer to the respective router documentation:

Previous
Graphs and variants
Next
Cloud setup
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company