spring-graphql.adoc (spring-boot-2.7.3) | : | spring-graphql.adoc (spring-boot-2.7.4) | ||
---|---|---|---|---|
skipping to change at line 35 | skipping to change at line 35 | |||
| TCP, WebSocket | | TCP, WebSocket | |||
| Spring WebFlux on Reactor Netty | | Spring WebFlux on Reactor Netty | |||
|=== | |=== | |||
[[web.graphql.schema]] | [[web.graphql.schema]] | |||
=== GraphQL Schema | === GraphQL Schema | |||
A Spring GraphQL application requires a defined schema at startup. | A Spring GraphQL application requires a defined schema at startup. | |||
By default, you can write ".graphqls" or ".gqls" schema files under `src/main/re sources/graphql/**` and Spring Boot will pick them up automatically. | By default, you can write ".graphqls" or ".gqls" schema files under `src/main/re sources/graphql/**` and Spring Boot will pick them up automatically. | |||
You can customize the locations with configprop:spring.graphql.schema.locations[ ] and the file extensions with configprop:spring.graphql.schema.file-extensions[ ]. | You can customize the locations with configprop:spring.graphql.schema.locations[ ] and the file extensions with configprop:spring.graphql.schema.file-extensions[ ]. | |||
NOTE: If you want Spring Boot to detect schema files in all your application mod | ||||
ules and dependencies for that location, | ||||
you can set configprop:spring.graphql.schema.locations[] to `+"classpath*:graphq | ||||
l/**/"+` (note the `classpath*:` prefix). | ||||
In the following sections, we'll consider this sample GraphQL schema, defining t wo types and two queries: | In the following sections, we'll consider this sample GraphQL schema, defining t wo types and two queries: | |||
[source,json,indent=0,subs="verbatim,quotes"] | [source,json,indent=0,subs="verbatim,quotes"] | |||
---- | ---- | |||
include::{docs-resources}/graphql/schema.graphqls[] | include::{docs-resources}/graphql/schema.graphqls[] | |||
---- | ---- | |||
NOTE: By default, https://spec.graphql.org/draft/#sec-Introspection[field intros pection] will be allowed on the schema as it is required for tools such as Graph iQL. | NOTE: By default, https://spec.graphql.org/draft/#sec-Introspection[field intros pection] will be allowed on the schema as it is required for tools such as Graph iQL. | |||
If you wish to not expose information about the schema, you can disable introspe ction by setting configprop:spring.graphql.schema.introspection.enabled[] to `fa lse`. | If you wish to not expose information about the schema, you can disable introspe ction by setting configprop:spring.graphql.schema.introspection.enabled[] to `fa lse`. | |||
End of changes. 1 change blocks. | ||||
0 lines changed or deleted | 5 lines changed or added |