Package io.quarkus.smallrye.graphql.runtime

Interface SmallRyeGraphQLConfig

@ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED) @ConfigMapping(prefix="quarkus.smallrye-graphql") public interface SmallRyeGraphQLConfig

  • Method Details

    • rootPath

      @WithDefault("graphql") String rootPath()
      The rootPath under which queries will be served. Default to graphql By default, this value will be resolved as a path relative to `${quarkus.http.root-path}`.

    • federationEnabled

      @WithName("federation.enabled") Optional<Boolean> federationEnabled()
      Enable Apollo Federation. If this value is unspecified, then federation will be enabled automatically if any GraphQL Federation annotations are detected in the application.

    • federationBatchResolvingEnabled

      @WithName("federation.batch-resolving-enabled") Optional<Boolean> federationBatchResolvingEnabled()
      Enable batch resolving for federation. Disabled by default.

    • metricsEnabled

      @WithName("metrics.enabled") Optional<Boolean> metricsEnabled()
      Enable metrics. By default, this is false. If set to true, a metrics extension is required.

    • tracingEnabled

      @WithName("tracing.enabled") Optional<Boolean> tracingEnabled()
      Enable tracing. By default, this will be enabled if the tracing extension is added.

    • eventsEnabled

      @WithName("events.enabled") @WithDefault("false") boolean eventsEnabled()
      Enable eventing. Allow you to receive events on bootstrap and execution.

    • nonBlockingEnabled

      @WithName("nonblocking.enabled") Optional<Boolean> nonBlockingEnabled()
      Enable non-blocking support. Default is true.

    • autoNameStrategy

      @WithDefault("Default") String autoNameStrategy()
      Change the type naming strategy. All possible strategies are: default, merge-inner-class, full

    • printDataFetcherException

      Optional<Boolean> printDataFetcherException()
      Print the data fetcher exception to the log file. Default `true` in dev and test mode, default `false` in prod.

    • schemaAvailable

      @WithDefault("true") boolean schemaAvailable()
      Make the schema available over HTTP.

    • websocketSubprotocols

      Optional<List<String>> websocketSubprotocols()
      Subprotocols that should be supported by the server for graphql-over-websocket use cases. Allowed subprotocols are "graphql-ws" and "graphql-transport-ws". By default, both are enabled.

    • ui

      @ConfigDocSection SmallRyeGraphQLUIConfig ui()
      SmallRye GraphQL UI configuration

    • extraScalars

      Optional<List<ExtraScalar>> extraScalars()
      Additional scalars to register in the schema. These are taken from the `graphql-java-extended-scalars` library.

    • authorizationClientInitPayloadName

      Optional<String> authorizationClientInitPayloadName()
      The name of the key inside the client init payload which contains Authorization information. The associated value of this is treated in the same way as sent over as a Authorization header. Using headers is the preferred way, however in some languages, such as JavaScript, it is not possible to send headers over websockets.
      If sending headers are not an option, another viable option is Bearer Token Authentication which might be preferable over this in some cases as it's able to inject headers before the WebSocket is opened.
      Default is undefined, which means the client init payload will not be checked for Authorization information.