Skip to content

Commit 1bbaf9e

Browse files
committed
Update links to Spring Boot starter section
Closes gh-254
1 parent 0343ad9 commit 1bbaf9e

File tree

2 files changed

+35
-23
lines changed

2 files changed

+35
-23
lines changed

spring-graphql-docs/src/docs/asciidoc/attributes.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@
1515
:github-wiki: https://github.com/{github-repo}/wiki
1616
:javadoc: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/api
1717
:spring-framework-ref-docs: https://docs.spring.io/spring-framework/docs/current/reference/html
18-
:spring-boot-version: current
18+
19+
// {spring-boot-version} attribute from build.gradle
1920
:spring-boot-ref-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference/html

spring-graphql-docs/src/docs/asciidoc/index.adoc

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ feedback. Please, use our
2020
https://github.com/spring-projects/spring-graphql/issues[issue tracker] to report a
2121
problem, discuss a design issue, or request a feature.
2222

23-
To get started, please see the <<boot-graphql>> and the <<samples>> sections.
23+
To get started, check the Spring GraphQL starter on https://start.spring.io and the
24+
<<samples>> sections.
2425

2526
[[requirements]]
2627
== Requirements
@@ -59,8 +60,10 @@ status is always 200 (OK), and any errors from GraphQL request execution appear
5960

6061
`GraphQlHttpHandler` can be exposed as an HTTP endpoint by declaring a `RouterFunction`
6162
bean and using the `RouterFunctions` from Spring MVC or WebFlux to create the route. The
62-
Boot starter does this, see <<boot-graphql-web>> for details or check
63-
`GraphQlWebMvcAutoConfiguration` or `GraphQlWebFluxAutoConfiguration` for example config.
63+
Boot starter does this, see the
64+
{spring-boot-ref-docs}/web.html#web.graphql.web-endpoints[Web Endpoints] section for
65+
details, or check `GraphQlWebMvcAutoConfiguration` or `GraphQlWebFluxAutoConfiguration`
66+
it contains, for the actual config.
6467

6568
The Spring for GraphQL repository contains a Spring MVC
6669
{github-main-branch}/samples/webmvc-http[HTTP sample] application.
@@ -100,8 +103,10 @@ https://github.com/enisdenjo/graphql-ws#recipes[recipes] for client use.
100103

101104
`GraphQlWebSocketHandler` can be exposed as a WebSocket endpoint by declaring a
102105
`SimpleUrlHandlerMapping` bean and using it to map the handler to a URL path. The Boot
103-
starter has options to enable this, see <<boot-graphql-web>> for details or check
104-
`GraphQlWebMvcAutoConfiguration` or `GraphQlWebFluxAutoConfiguration` for example config.
106+
starter has options to enable this, see the
107+
{spring-boot-ref-docs}/web.html#web.graphql.web-endpoints[Web Endpoints] section for
108+
details, or check `GraphQlWebMvcAutoConfiguration` or `GraphQlWebFluxAutoConfiguration`
109+
it contains, for the actual config.
105110

106111
The Spring for GraphQL repository contains a WebFlux
107112
{github-main-branch}/samples/webflux-websocket[WebSocket sample] application.
@@ -156,11 +161,10 @@ class MyInterceptor implements WebInterceptor {
156161

157162
`WebGraphQlHandler` provides a builder to initialize the Web interception chain. After
158163
you build the chain, you can use the resulting `WebGraphQlHandler` to initialize the HTTP
159-
or WebSocket transport handlers. The Boot starter configures all this,
160-
see <<boot-graphql-web>> for details, or check `GraphQlWebMvcAutoConfiguration` or
161-
`GraphQlWebFluxAutoConfiguration` for example config.
162-
163-
164+
or WebSocket transport handlers. The Boot starter configures all this, see the
165+
{spring-boot-ref-docs}/web.html#web.graphql.web-endpoints[Web Endpoints] section for
166+
details, or check `GraphQlWebMvcAutoConfiguration` or `GraphQlWebFluxAutoConfiguration`
167+
it contains, for the actual config.
164168

165169

166170
[[execution]]
@@ -193,10 +197,11 @@ support for <<execution-reactive-datafetcher>>, <<execution-context>>, and
193197

194198
`GraphQlSource.Builder` can be configured with one or more `Resource` instances to be
195199
parsed and merged together. That means schema files can be loaded from just about any
196-
location. By default, the Spring Boot starter <<boot-graphql-schema,loads schema files>>
197-
from a well-known classpath location, but you can change that to a location on the file system
198-
via `FileSystemResource`, to byte content via `ByteArrayResource`, or implement a custom
199-
`Resource` that loads schema files from a remote location or storage.
200+
location. By default, the Spring Boot starter
201+
{spring-boot-ref-docs}/web.html#web.graphql.schema[loads schema files]
202+
from a well-known classpath location, but you can change that to a location on the file
203+
system via `FileSystemResource`, to byte content via `ByteArrayResource`, or implement a
204+
custom `Resource` that loads schema files from a remote location or storage.
200205

201206

202207
[[execution-graphqlsource-schema-creation]]
@@ -323,7 +328,8 @@ public class RequestAttributesAccessor implements ThreadLocalAccessor {
323328

324329
A `ThreadLocalAccessor` can be registered in the <<web-interception,WebGraphHandler>>
325330
builder. The Boot starter detects beans of this type and automatically registers them for
326-
Spring MVC application, see <<boot-graphql-web>>.
331+
Spring MVC application, see the
332+
{spring-boot-ref-docs}/web.html#web.graphql.web-endpoints[Web Endpoints] section.
327333

328334

329335
[[execution-context-webflux]]
@@ -418,8 +424,7 @@ public class MyConfig {
418424
}
419425
----
420426

421-
The Spring Boot starter declares a
422-
<<boot-graphql-batch-loader-registry,BatchLoaderRegistry bean>> so you can inject it into
427+
The Spring Boot starter declares a `BatchLoaderRegistry` bean that you can inject into
423428
your configuration, as shown above, or into any component such as a controller in order
424429
register batch loading functions. In turn the `BatchLoaderRegistry` is injected into
425430
`ExecutionGraphQlService` where it ensures `DataLoader` registrations per request.
@@ -619,8 +624,10 @@ Auto-registration detects if a given repository implements `QuerydslBinderCustom
619624
transparently applies that through `QuerydslDataFetcher` builder methods.
620625

621626
Auto-registration is performed through a `RuntimeWiringConfigurer` which can be obtained
622-
from `QuerydslDataFetcher`. The <<boot-repositories-querydsl,Boot starter>> automatically
623-
detects `@GraphQlRepository` beans and uses them to configure the `RuntimeWiringConfigurer`.
627+
from `QuerydslDataFetcher`. The
628+
{spring-boot-ref-docs}/web.html#web.graphql.data-query[Boot starter] automatically
629+
detects `@GraphQlRepository` beans and uses them to initialize the
630+
`RuntimeWiringConfigurer` with.
624631

625632

626633

@@ -692,8 +699,10 @@ of the repository domain type. If needed, you can use the `typeName` attribute o
692699
`@GraphQlRepository` to specify the target GraphQL type name.
693700

694701
Auto-registration is performed through a `RuntimeWiringConfigurer` which can be obtained from
695-
`QueryByExampleDataFetcher`. The <<boot-repositories-querybyexample,Boot starter>> automatically
696-
detects `@GraphQlRepository` beans and uses them to configure the `RuntimeWiringConfigurer`.
702+
`QueryByExampleDataFetcher`. The
703+
{spring-boot-ref-docs}/web.html#web.graphql.data-query[Boot starter] automatically
704+
detects `@GraphQlRepository` beans and uses them to initialize the
705+
`RuntimeWiringConfigurer` with.
697706

698707

699708

@@ -738,7 +747,9 @@ annotated handler methods as ``DataFetcher``s via `RuntimeWiring.Builder`. It is
738747
implementation of `RuntimeWiringConfigurer` which can be added to `GraphQlSource.Builder`.
739748
The Spring Boot starter automatically declares `AnnotatedControllerConfigurer` as a bean
740749
and adds all `RuntimeWiringConfigurer` beans to `GraphQlSource.Builder` and that enables
741-
support for annotated ``DataFetcher``s, see <<boot-graphql-runtimewiring>>.
750+
support for annotated ``DataFetcher``s, see the
751+
{spring-boot-ref-docs}/web.html#web.graphql.runtimewiring[GraphQL RuntimeWiring] section
752+
in the Boot starter documentation.
742753

743754

744755
[[controllers-schema-mapping]]

0 commit comments

Comments
 (0)