Learn HyperRoute
Everything you need to build, deploy, and scale your GraphQL federation. From quick starts to deep dives.
Getting Started
Set up HyperRoute and run your first federated query.
Core Router
Deep dives into architecture, performance, security, and every Core feature.
Architecture
How HyperRoute's components work together to power your federation.
Federation
Compose multiple GraphQL subgraphs into a single unified API with HyperRoute's federation engine.
REST & gRPC Subgraphs
Federate non-GraphQL services — expose REST APIs and gRPC services as GraphQL subgraphs.
Caching
Distributed caching with memory, Redis, and layered L1/L2 backends for query plans, entities, and APQ.
Incremental Delivery
Progressive loading with @defer and @stream — send critical data first, load the rest in the background.
Observability
Built-in health checks, Prometheus metrics, distributed tracing, and alerting — production-ready from day one.
Plugins & Coprocessors
Extend the request lifecycle with built-in plugins and external HTTP coprocessors.
Subscriptions & Polling
Real-time GraphQL subscriptions via SSE and WebSocket, plus the zero-backend @poll directive.
Deployment
Deploy HyperRoute to Kubernetes, Docker Compose, or bare metal with production-ready configurations.
Migrating from Apollo
Step-by-step guide to migrate from Apollo Router to HyperRoute — config mapping, key differences, and migration steps.
Configuration
Complete configuration reference for router.yaml — every option explained with defaults.
Security
Built-in protection for your GraphQL API — no premium tier required.
DevKit CLI
Build, validate, and deploy subgraph bundles with the DevKit command-line tool.
DevKit Overview
Production-grade CLI for GraphQL federation management — compose, validate, package, and deploy supergraph bundles.
Installation
Install HyperRoute DevKit CLI via the one-liner script, from source, or a specific version.
Quick Start
Push your first subgraph in 5 minutes — GraphQL, REST, and gRPC examples with no cloud dependencies.
Architecture
System architecture, bundle delivery, multi-protocol routing, and API endpoint reference for HyperRoute DevKit.
Core Concepts
Understand subgraph types, bundles, snapshots, and environments — the building blocks of HyperRoute federation.
Routing Directives
Schema-based @rest and @grpc directives for multi-protocol GraphQL federation.
CI/CD Integration
Integrate HyperRoute DevKit into GitHub Actions, GitLab CI, and any CI/CD pipeline with exit codes and JSON output.
Troubleshooting
Common issues and diagnostic commands for HyperRoute DevKit — router connectivity, REST 404s, gRPC errors, and more.
Tutorials
Step-by-step tutorials for federating REST APIs, gRPC services, and mixed multi-protocol supergraphs.
CLI Reference
Complete reference for all HyperRoute DevKit CLI commands — schema management, bundle lifecycle, governance, and more.
Configuration
Complete devkit.yaml configuration reference — subgraphs, platform API, registry, environments, and router settings.
Push & Governance
Deep dive into the push command — local vs cloud mode, governance workflow, exit codes, and approval pipelines.
Need Help?
Can't find what you're looking for? Our team is here to help.