Prev Next

API / Apollo Gateway Interview questions

How does the @external directive work?

@external declares that a field is actually owned and defined by another subgraph, and this subgraph is only referencing it — typically because it needs that field's value as an input to @requires, or is supplying it via @provides.

type Product @key(fields: "id") {
  id: ID!
  weight: Float! @external
  shippingEstimate: Float! @requires(fields: "weight")
}

Here, the Shipping subgraph doesn't own weight — it's marked @external to tell composition "I know this field exists elsewhere, don't treat my declaration of it as a conflicting definition." The gateway fetches weight from the owning subgraph first, then passes it along so Shipping can compute shippingEstimate.

In Federation 2, many former uses of bare @external have been narrowed since @shareable now covers the simple "resolved in more than one place" case more explicitly.

What does marking a field @external communicate to the composition process?
@external is most commonly paired with which other directive to pull in a needed value?

More Related questions...

What is Apollo Gateway? What is GraphQL Federation? What is a subgraph in Apollo Federation? What is a supergraph in Apollo Federation? What is the difference between Apollo Server and Apollo Gateway? What is Apollo Federation 2? What are entities in Apollo Federation? What is the @key directive used for? What is schema composition in Apollo Federation? What is managed federation? What is Apollo Studio / GraphOS? What is Rover CLI used for? What is a query plan? What are the main directives used in Apollo Federation? What is the difference between Apollo Gateway and Apollo Router? Why do we use Apollo Federation instead of GraphQL schema stitching? How does Apollo Gateway compose a supergraph? How does the @external directive work? How does the @requires directive work? How does the @provides directive work? What is the difference between @shareable and @override? When should you use Apollo Router instead of Apollo Gateway? How do you configure Apollo Gateway with Apollo Server? What happens when a subgraph is unavailable at runtime? How does Apollo Gateway handle authentication and authorization? Why doesn't Apollo Gateway support GraphQL subscriptions as robustly as Apollo Router does? What is the difference between Federation 1 and Federation 2? How do you debug query planning issues in Apollo Gateway? What is the difference between IntrospectAndCompose and managed federation in Apollo Gateway? How can you optimize Apollo Gateway performance? Explain the lifecycle of a GraphQL request through Apollo Gateway? Explain the internal working of entity resolution using _entities and reference resolvers? What is the difference between a monolithic GraphQL server and a federated Apollo Gateway architecture? How does Apollo Gateway handle errors returned by subgraphs? What is the purpose of the _service and _entities fields in a federated subgraph schema? How do you implement custom middleware or plugins in Apollo Gateway? What are contract variants in GraphOS? How do you handle the N+1 query problem when a field spans multiple subgraphs? What is the difference between @override and @external for migrating fields? How does Apollo Gateway / Router handle caching? Explain the execution flow of a federated query spanning three subgraphs? Which is better and why: Apollo Router or Apollo Gateway, for a high-throughput production system? How do you secure inter-service communication between the gateway and subgraphs? What are Automatic Persisted Queries (APQ) and how do they work with Apollo Gateway? How do you handle versioning and backward compatibility of subgraph schemas? What is the difference between self-hosted Apollo Router and the GraphOS Router (cloud)? How do you troubleshoot composition errors when publishing a new subgraph schema? Explain the internal working of query plan caching? How can you implement rate limiting at the Apollo Gateway or Router level? What is the future direction of Apollo Gateway compared to Apollo Router?
Show more question and Answers...


Comments & Discussions