Package io.micronaut.configuration.graphql

Class GraphQLConfiguration.GraphiQLConfiguration

java.lang.Object
io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
All Implemented Interfaces:
io.micronaut.core.util.Toggleable
Enclosing class:
GraphQLConfiguration
@ConfigurationProperties("graphiql") public static class GraphQLConfiguration.GraphiQLConfiguration extends Object implements io.micronaut.core.util.Toggleable
Configuration properties for GraphiQL.

  • Field Details

    • PREFIX

      public static final String PREFIX
      The prefix to use for all GraphiQL configuration properties.
      See Also:

    • ENABLED_CONFIG

      public static final String ENABLED_CONFIG
      The configuration name whether GraphiQL is enabled.
      See Also:

    • DEFAULT_ENABLED

      public static final boolean DEFAULT_ENABLED
      The default enabled value.
      See Also:

    • VERSION_CONFIG

      public static final String VERSION_CONFIG
      The configuration name of the GraphiQL version.
      See Also:

    • EXPLORER_PLUGIN_VERSION

      public static final String EXPLORER_PLUGIN_VERSION
      The configuration name of the GraphIQL Explorer plugin version.
      Since:
      4.1
      See Also:

    • DEFAULT_VERSION

      public static final String DEFAULT_VERSION
      The default GraphiQL version.
      See Also:

    • DEFAULT_EXPLORER_PLUGIN_VERSION

      public static final String DEFAULT_EXPLORER_PLUGIN_VERSION
      The default GraphIQL Explorer plugin version.
      Since:
      4.1
      See Also:

    • PATH_CONFIG

      public static final String PATH_CONFIG
      The configuration name of the GraphiQL path.
      See Also:

    • DEFAULT_PATH

      public static final String DEFAULT_PATH
      The default GraphiQL path.
      See Also:

    • TEMPLATE_PATH_CONFIG

      public static final String TEMPLATE_PATH_CONFIG
      The configuration name of the GraphiQL template path.
      See Also:

    • DEFAULT_TEMPLATE_PATH

      public static final String DEFAULT_TEMPLATE_PATH
      The default GraphiQL template path.
      See Also:

    • TEMPLATE_PARAMETERS_CONFIG

      public static final String TEMPLATE_PARAMETERS_CONFIG
      The configuration name of the GraphiQL template parameters.
      See Also:

    • DEFAULT_TEMPLATE_PARAMETERS

      public static final Map<String,String> DEFAULT_TEMPLATE_PARAMETERS
      The default GraphiQL template parameters.

    • PAGE_TITLE_CONFIG

      public static final String PAGE_TITLE_CONFIG
      The configuration name of the GraphiQL page title.
      See Also:

    • DEFAULT_PAGE_TITLE

      public static final String DEFAULT_PAGE_TITLE
      The default GraphiQL page title.
      See Also:

    • enabled

      protected boolean enabled

    • version

      protected String version

    • explorerPluginVersion

      protected String explorerPluginVersion

    • path

      protected String path

    • templatePath

      protected String templatePath

    • templateParameters

      protected Map<String,String> templateParameters

    • pageTitle

      protected String pageTitle

  • Constructor Details

    • GraphiQLConfiguration

      public GraphiQLConfiguration()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Returns whether GraphiQL is enabled. Default value (false).
      Specified by:
      isEnabled in interface io.micronaut.core.util.Toggleable
      Returns:
      whether GraphiQL is enabled

    • getVersion

      public String getVersion()
      Returns the GraphiQL version. Default value ("3.0.6").
      Returns:
      the GraphiQL version

    • getExplorerPluginVersion

      public String getExplorerPluginVersion()
      Returns the GraphIQL Explorer plugin version. Default value ("0.3.5").
      Returns:
      the GraphIQL Explorer plugin version
      Since:
      4.1

    • getPath

      public String getPath()
      Returns the GraphiQL path. Default value ("/graphiql").
      Returns:
      the GraphiQL path

    • getTemplatePath

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

    • getTemplateParameters

      public Map<String,String> getTemplateParameters()
      Returns the GraphiQL template parameters to be substituted in the template.
      Returns:
      the GraphiQL template parameters

    • getPageTitle

      public String getPageTitle()
      Returns the GraphiQL page title. Default value ("GraphiQL").
      Returns:
      the GraphiQL page title