Add section on directives in reference docs

Closes gh-262
This commit is contained in:
rstoyanchev
2022-02-17 15:17:27 +00:00
parent 194126dc6b
commit afb0b64d3a
2 changed files with 37 additions and 3 deletions

View File

@@ -13,7 +13,7 @@
:github-issues: https://github.com/{github-repo}/issues/
:github-main-branch: https://github.com/{github-repo}/tree/main
:github-wiki: https://github.com/{github-repo}/wiki
:graphql-java-docs: https://www.graphql-java.com/documentation/v16
:graphql-java-docs: https://www.graphql-java.com/documentation
:javadoc: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/api
:spring-framework-ref-docs: https://docs.spring.io/spring-framework/docs/current/reference/html

View File

@@ -199,8 +199,8 @@ the following:
- Expose {spring-boot-ref-docs}/application-properties.html#appendix.application-properties.web[properties]
that apply to `GraphQlSource.Builder`.
- Detect <<execution-graphqlsource-runtimewiring-configurer>> beans.
- Detect `Instrumentation` beans for GraphQL
{spring-boot-ref-docs}/actuator.html#actuator.metrics.supported.spring-graphql[metrics].
- Detect https://www.graphql-java.com/documentation/instrumentation[Instrumentation] beans for
{spring-boot-ref-docs}/actuator.html#actuator.metrics.supported.spring-graphql[GraphQL metrics].
- Detect `DataFetcherExceptionResolver` beans for
<<execution-exceptions, exception resolution>>.
- Detect `GraphQlSourceBuilderCustomizer` beans for any other customizations.
@@ -329,6 +329,40 @@ builder.schemaResources(..)
----
[[execution-graphqlsource-directives]]
==== Directives
The GraphQL language supports directives that "describe alternate runtime execution and
type validation behavior in a GraphQL document". Directives are similar to annotations in
Java but declared on types, fields, fragments and operations in a GraphQL document.
GraphQL Java provides the `SchemaDirectiveWiring` contract to help applications detect
and handle directives. For more details, see
{graphql-java-docs}/sdl-directives/[Schema Directives] in the
GraphQL Java documentation.
In Spring GraphQL you can register a `SchemaDirectiveWiring` through a
<<execution-graphqlsource-runtimewiring-configurer>>. The Spring Boot starter detects
such beans, so you might have something like:
[source,java,indent=0,subs="verbatim,quotes"]
----
@Configuration
public class GraphQlConfig {
@Bean
public RuntimeWiringConfigurer runtimeWiringConfigurer() {
return builder -> builder.directiveWiring(new MySchemaDirectiveWiring());
}
}
----
TIP: For an example of directives support check out the
https://github.com/graphql-java/graphql-java-extended-validation[Extended Validation for Graphql Java]
library.
[[execution-reactive-datafetcher]]
=== Reactive `DataFetcher`