Gloo GraphQL module
Create GraphQL APIs directly in Envoy using declarative configuration with Gloo Gateway and Gloo Mesh.
Why GraphQL?
GraphQL is a server-side query language and runtime you can use to expose your APIs as an alternative to REST APIs. GraphQL allows you to request only the data you want and handle any subsequent requests on the server side, saving numerous expensive origin-to-client requests by instead handling requests in your internal network.
Using GraphQL in an API gateway
API gateways expose microservices with different implementations from a single location and schema. The API gateway acts like a single owner for all requests and responses. As such, it can shape traffic according to consistent policies that you set. When you integrate with GraphQL, you get the benefits of an API gateway and more. GraphQL exposes your API to allow clients to interact with the API on their own terms. Additionally, you can mix and match your GraphQL graph with your existing REST routes. This setup lets you test and migrate to GraphQL at a pace that makes sense for your organization.
Gloo Gateway extends API gateway and GraphQL capabilities with route-level control. Usually, API gateways apply edge networking logic at the route level. For example, the gateway might rate limit, authorize, and authenticate requests. Most GraphQL servers are a separate endpoint behind the API gateway. Therefore, you cannot add route-level customizations. In contrast, Gloo Gateway embeds route-level customization logic into the API gateway.
Get started
Check out the following pages to set up GraphQL in your Gloo environment.
-
Get started: Get started with GraphQL in Gloo Gateway.
-
Explore the GraphQL UI: Visualize your GraphQL API and services in the GraphQL UI.
-
Define API schema: Define what kind of data can be returned to a GraphQL query.
-
Define resolvers: Select GraphQL services in your Gloo environment to resolve each GraphQL schema field.
-
Route to GraphQL servers: Set up routing to your GraphQL servers, and optionally apply GraphQL policies to the routes.
-
Cache queries: Improve network performance by caching GraphQL queries.
-
Allow only specific queries: Prevent malicious requests to your GraphQL servers by specifying allowed queries.
-
Monitor GraphQL health: Gather metrics for your GraphQL services in Prometheus.