Configuration Reference

Version:4.2.1

Micronaut Graphql Config Properties

🔗
Table 1. Configuration Properties for GraphQLWsConfiguration
Property Type Description

graphql.graphql-ws.enabled

boolean

Returns whether GraphQL websocket is enabled.

graphql.graphql-ws.path

java.lang.String

Returns the GraphQL websocket path.

graphql.graphql-ws.connection-init-wait-timeout

java.time.Duration

Returns the connection intialisation wait timeout.

🔗
Table 2. Configuration Properties for GraphQLApolloWsConfiguration
Property Type Description

graphql.graphql-apollo-ws.enabled

boolean

Returns whether GraphQL websocket is enabled.

graphql.graphql-apollo-ws.path

java.lang.String

Returns the GraphQL websocket path.

graphql.graphql-apollo-ws.keep-alive-enabled

boolean

Returns whether GraphQL websocket keep alive is enabled.

graphql.graphql-apollo-ws.keep-alive-interval

java.lang.String

Returns the GraphQL keep alive interval in seconds.

🔗
Table 3. Configuration Properties for GraphQLConfiguration
Property Type Description

graphql.enabled

boolean

Returns whether GraphQL is enabled.

graphql.path

java.lang.String

Returns the GraphQL path.

🔗
Table 4. Configuration Properties for GraphQLConfiguration$GraphiQLConfiguration
Property Type Description

graphql.graphiql.enabled

boolean

Returns whether GraphiQL is enabled. Default value (false).

graphql.graphiql.version

java.lang.String

Returns the GraphiQL version. Default value ("3.0.6").

graphql.graphiql.explorer-plugin-version

java.lang.String

Returns the GraphIQL Explorer plugin version. Default value ("0.3.5").

graphql.graphiql.path

java.lang.String

Returns the GraphiQL path. Default value ("/graphiql").

graphql.graphiql.template-path

java.lang.String

Returns the GraphiQL template path. Default value ("classpath:graphiql/index.html").

graphql.graphiql.template-parameters

java.util.Map

Returns the GraphiQL template parameters to be substituted in the template.

graphql.graphiql.page-title

java.lang.String

Returns the GraphiQL page title. Default value ("GraphiQL").