Graphweaver supports GraphQL Federation v1 and v2. GraphQL federation allows you to combine multiple GraphQL APIs (called subgraphs) into a single unified graph. This means you can have different teams or services manage their own GraphQL APIs independently and still provide a seamless experience for clients who only need to interact with the single federated graph.

Enable Federation in Graphweaver

There are a few important steps you will need to follow to enable federation on Graphweaver.

Graphweaver Configuration

There are two configuration options for Federation in Graphweaver.

• federationSubgraphName - Setting this to your team name will enable the additional Federation directives and queries in your API, as well as namespacing all singleton types we use so they won’t clash with other Graphweaver instances behind the same federation router.
• enableFederationTracing - This enables the ability to trace requests through the federation.

<aside> 🔥 Caution: With enableFederationTracing, any client can request a trace for any operation, potentially revealing sensitive server information. It is recommended to ensure that federated subgraphs are not directly exposed to the public Internet. This feature is disabled by default for security reasons.

</aside>

Here is how you configure these settings in your app:

export const graphweaver = new Graphweaver({
	federationSubgraphName: 'music',
	enableFederationTracing: true,
});

Once federationSubgraphName is set to a string the Graphweaver server will add the following Federation queries to the server:

• _service - support for the rover subgraph introspect command (this is the Federation equivalent of Introspection for subgraphs)
• _entities - query to fetch entity data
  • Below is an example of the single @key query that is sent from the graph router to the implementing products subgraph:

query {
    _entities(representations: [{ "__typename": "User", "email": "[email protected]" }]) {
        ...on User { email name }
      }
    }
}