Skip to content

Federation Gateway

In this lesson you will learn federation gateway in GraphQL, why it matters within graphql federation, and how to use it correctly with clear, copy-ready examples.

Federation Gateway Overview

Federation Gateway is a building block you will reach for often in GraphQL. It keeps related logic together and makes your intent obvious to reviewers and future maintainers.

When you learn federation gateway properly, you avoid the guesswork that leads to bugs and rework. The example below shows the shape you will use in most real GraphQL projects.

import { buildSubgraphSchema } from '@apollo/subgraph';

const typeDefs = gql`
  type User @key(fields: "id") {
    id: ID!
    name: String!
  }
`;

const schema = buildSubgraphSchema({ typeDefs, resolvers });

Federation composes multiple subgraph services into one unified GraphQL API.

Federation Gateway Example

const typeDefs = gql`
  type Query { hello: String! }
`;
const resolvers = { Query: { hello: () => 'world' } };
const server = new ApolloServer({ typeDefs, resolvers });
  • Start from a minimal Federation Gateway example and grow it only as needed.
  • Keep configuration explicit so Federation Gateway behaves the same in every environment.
  • Name things clearly so teammates understand your Federation Gateway at a glance.
  • Add tests around Federation Gateway early to lock in expected behaviour.

GraphQL Cheatsheet

Quick GraphQL reference related to federation gateway.

Concept Example Purpose
Schema type Query { user(id: ID!): User } Define the API shape
Resolver Query: { user: (_, { id }) => ... } Provide field data
Query query { user(id: 1) { name } } Read exactly what you need
Mutation mutation { createUser(input) { id } } Change data
Subscription subscription { postAdded { id } } Real-time updates
Context context: ({ req }) => ({ user }) Auth and shared state
DataLoader loader.load(id) Batch to avoid N+1

How Federation Gateway Works in GraphQL

Federation Gateway fits into GraphQL's model of a single typed schema that clients query for exactly the data they need. The server resolves each requested field through resolver functions.

Federation composes multiple subgraph services into one unified GraphQL API.

  • The schema is the contract between client and server.
  • Resolvers fetch data field by field, including nested types.
  • Clients request only the fields they use, avoiding over-fetching.
  • Context carries auth and shared services into every resolver.

Practical Guidance for Federation Gateway

In production, federation gateway should be efficient and secure. Batch data access with DataLoader, guard resolvers with authorization, and limit query depth and complexity.

Concern Recommendation
N+1 queries Batch with DataLoader
Security Auth in context, depth/complexity limits
Errors Typed GraphQLError with extension codes
Performance Cache and paginate large lists

Common Mistakes

  • Copying federation gateway snippets without understanding what each line does.
  • Skipping error handling and edge cases when wiring up federation gateway.
  • Leaving federation gateway untested, so regressions slip into production.
  • Over-engineering federation gateway before you actually need the extra flexibility.

Key Takeaways

  • Federation Gateway is a core part of working effectively with GraphQL.
  • Start small and keep federation gateway focused on a single responsibility.
  • Apply consistent patterns so federation gateway scales across your project.
  • Test and document federation gateway to keep it maintainable over time.

Pro Tip

Pair federation gateway with automated tests from day one. It is far cheaper to catch GraphQL regressions in CI than in production.