Netflix DGS Framework

The DGS Framework (Domain Graph Service) is a GraphQL server framework for Spring Boot developed by Netflix. It provides an annotation-based Spring Boot programming model and includes features such as:

• A test framework for writing query tests as unit tests.
• A Gradle Code Generation plugin to create types from your GraphQL schema.
• Easy integration with GraphQL Federation.
• Integration with Spring Security.
• Support for GraphQL subscriptions via WebSockets and SSE.
• File upload support.
• Robust error handling.
• Numerous extension points for customization.

Use the graphql-dgs-platform Bill of Materials (BOM) to simplify dependency management in Maven or Gradle projects. This BOM provides version recommendations for DGS Framework Modules and their public API dependencies.

Note: This BOM only includes dependencies exposed as part of the DGS Framework API. If you require a BOM that includes internal dependencies used by the framework, use the graphql-dgs-platform-dependencies BOM instead.

To start the example application, run the ExampleApp class from your IDE. This application demonstrates DGS framework features and includes a React UI that connects to both /graphql and /subscriptions endpoints using Apollo Client.

Once running, you can access the following interfaces:

• GraphiQL IDE: http://localhost:8080/graphiql
• Example React UI: http://localhost:8080/index.html

To start the example application, run the ExampleApp class from your IDE. This application demonstrates DGS framework features and includes a React UI that connects to both /graphql and /subscriptions endpoints via Apollo Client.

Once running, you can access the following:

• GraphiQL interface: http://localhost:8080/graphiql
• React UI: http://localhost:8080/index.html

Ensure your Spring Boot version is compatible with the DGS version you intend to use:

The CustomMonoGraphQLClient class is deprecated because it is tied to Jackson 2. For future compatibility and support for any DgsJsonMapper (including Jackson 3), you should migrate to DgsCustomMonoGraphQLClient.

Migration Path: Replace com.netflix.graphql.dgs.client.CustomMonoGraphQLClient with com.netflix.graphql.dgs.client.DgsCustomMonoGraphQLClient.

The WebClientGraphQLClient provides a reactive way to execute GraphQL queries using Spring's WebClient. It returns a Mono<GraphQLResponse>, allowing you to extract data or handle errors reactively. You can provide a WebClient instance configured with your GraphQL endpoint URL.

WebClientGraphQLClient webClientGraphQLClient =
    new WebClientGraphQLClient(WebClient.create("http://localhost:8080/graphql"));
GraphQLResponse message = webClientGraphQLClient.reactiveExecuteQuery("{hello}")
                                                .map(r -> r.extractValue<String>("hello"));
message.subscribe();

The WebClientGraphQLClient supports several variations of reactiveExecuteQuery to handle different query requirements:

• reactiveExecuteQuery(query: String): Executes a simple query string.
• reactiveExecuteQuery(query: String, variables: Map<String, Any>): Executes a query with a map of input variables.
• reactiveExecuteQuery(query: String, variables: Map<String, Any>, operationName: String?): Executes a query with variables and a specific operation name.
• reactiveExecuteQuery(query: String, requestBodyUriCustomizer: RequestBodyUriCustomizer): Allows customizing the request URI and headers via a customizer.
• reactiveExecuteQuery(query: String, variables: Map<String, Any>, operationName: String?, requestBodyUriCustomizer: RequestBodyUriCustomizer): The most flexible method, combining variables, operation names, and URI/header customization.