Spring/spring-graphql
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document minimum standalone setup for GraphQL support

Browse Source 
Most Spring for GraphQL applications use Spring Boot as a way to
auto-configure the required infrastructure for running GraphQL
applications.

This commit documents a minimal setup for Spring applications not
relying on Spring Boot. This assumes an existing infrastructure for a
Spring MVC application.

Closes gh-606
This commit is contained in:
Brian Clozel
2024-07-12 16:06:48 +02:00
parent 441b18d919
commit c1ed773cc7
3 changed files with 89 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-graphql-docs/modules/ROOT/nav.adoc
View File

@@ -12,4 +12,5 @@
* xref:graphiql.adoc[]
* xref:testing.adoc[]
* xref:boot-starter.adoc[]
* xref:standalone-setup.adoc[]
* xref:samples.adoc[]

15
spring-graphql-docs/modules/ROOT/pages/standalone-setup.adoc Normal file
View File

@@ -0,0 +1,15 @@
[[standalone-setup]]
= Standalone Setup
If your application is not using Spring Boot, you are responsible for setting up the relevant Spring for GraphQL components.
Assuming that your application is already configured for Spring MVC controllers, the minimum setup will require several beans.
include-code::GraphQlConfiguration[]
<1> The `AnnotatedControllerConfigurer` bean is responsible for detecting GraphQL `@Controller` handlers.
<2> The `ExecutionGraphQlService` processes GraphQL requests in a transport-agnostic fashion.
<3> The `GraphQlSource` builder is the main configuration point. Explore its API for more options.
<4> The `RouterFunction` exposes the GraphQL routes as {spring-framework-ref-docs}/web/webmvc-functional.html[functional endpoints].
<5> You can then expose various transports (WebSocket, SSE, HTTP) over different routes.
Spring for GraphQL offers many other options and integrations with Spring projects.
For more on this, you can xref:boot-starter.adoc[explore the Spring Boot auto-configurations].