repository·dev·Indexed 21 days ago
https://github.com/apollographql/routerAn internal Rust-based component of the Apollo Router designed to run Apollo Federation 2 supergraphs. It includes the JSONSelection syntax, a declarative string literal system used with the @connect directive to transform JSON data into GraphQL-shaped JSON without procedural resolver code.
The GraphOS Router acts as the public entry point for a federated GraphQL API and is responsible for protecting downstream subgraphs from malicious clients. It implements a defense-in-depth security model by applying authentication and authorization measures at multiple layers: the client, the router, and the subgraphs.
Key security capabilities include:
Apollo GraphOS serves as a central hub for monitoring the health and performance of your deployed supergraph. It collects operation and field usage metrics from clients, routers, and subgraphs.
Key capabilities include:
GraphQL subscriptions allow clients to receive real-time data updates (e.g., notifications, chat, stock tickers) without constant polling.
Key Connectivity Model:
Requirements:
subscription OnStockPricesChanged {
stockPricesChanged {
symbol
price
}
}GraphOS Router v2.x is the latest Apollo runtime platform, featuring a new Native Query Planner written in Rust for improved CPU and memory efficiency. Key enhancements include:
axum, http, hyper, opentelemetry, and redis.apollo-federation crate is an internal component of the Apollo Router. It is not intended to be used directly by end-users or external developers.The connect-migrate tool is a developer-facing CLI used to migrate Apollo Connectors schemas across different connect/v0.X spec versions (e.g., moving from v0.3 to v0.4).
Key capabilities include:
@connect(selection: ...) directives and dual-parsing them under different spec versions.recommendations.md or JSONL data (via the --format=json flag) following the v1 format spec.agent-guide command.The following features are available in the Apollo Router but require a licensed GraphOS plan and integration with Apollo GraphOS:
@requiresScopes, @authenticated, and @policy directives.The examples/ directory provides various ways to use and extend the Apollo Router. Examples are categorized by how they implement functionality:
telemetry).logging, cookies-to-headers).async-auth, jwt-auth).When using an API gateway in front of the GraphOS Router, the gateway must support streaming multipart responses rather than buffering them. Support varies by vendor:
buffer-response="false" in the forward-request policy.response.streaming.enabled to true in ProxyEndpoint and TargetEndpoint.Apollo Router can collect and export tracing information to various backends. The router generates spans that capture request phases, sub-request response times, query shapes, and router post-processing.
Supported exporters include:
To maximize the effectiveness of distributed tracing, ensure all components in your system are instrumented.
When using managed federation, your router (either GraphOS Router or @apollo/gateway) regularly polls an endpoint called Apollo Uplink to fetch its latest supergraph schema and other configuration settings. If you are using Enterprise features, Uplink also serves your router's license.
To ensure high availability, Uplink is hosted at two endpoints:
https://uplink.api.apollographql.com/https://aws.uplink.api.apollographql.com/