Crate apollo_router

Components of a federated GraphQL Server.

Most of these modules are of varying interest to different audiences.

If your interests are confined to developing plugins, then the following modules are likely to be of most interest to you:

• self - this module (apollo_router) contains high level building blocks for a federated GraphQL router

• graphql - graphql specific functionality for requests, responses, errors

• layers - examples of tower layers used to implement plugins

• plugin - various APIs for implementing a plugin

• services - the various services handling a GraphQL requests, and APIs for plugins to intercept them

Modules

graphql

Types related to GraphQL requests, responses, etc.

layers

Reusable layers Layers that are specific to one plugin should not be placed in this module.

plugin

Plugin system for the router.

services

Implementation of the various steps in the router’s processing pipeline.

tracer

Trace Ids for the router.

Macros

register_plugin

Register a plugin with a group and a name Grouping prevent name clashes for plugins, so choose something unique, like your domain name. Plugins will appear in the configuration as a layer property called: {group}.{name}

Structs

Configuration

The configuration for the router.

Context

A map of arbitrary JSON values, for use by plugins.

Endpoint

A path and a handler to be exposed as a web_endpoint for plugins

Executable

Entry point into creating a router executable with more customization than main.

MockedSubgraphs

a list of subgraphs with pregenerated responses

RouterHttpServer

The entry point for running the Router’s HTTP server.

TestHarness

Builder for the part of an Apollo Router that handles GraphQL requests, as a tower::Service.

Enums

ApolloRouterError

Error types for FederatedServer.

ConfigurationSource

The user supplied config. Either a static instance or a stream for hot reloading.

EntitlementSource

Entitlement controls availability of certain features of the Router. This API experimental and is subject to change outside of semver.

ListenAddr

Listening address.

SchemaSource

The user supplied schema. Either a static string or a stream for hot reloading.

ShutdownSource

Specifies when the Router’s HTTP server should gracefully shutdown

Functions

main

This is the main router entrypoint.