iframe-proxy | Sunbelt Computer Software

Repository navigation

<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>GraphQL Java Kickstart</title><link>https://graphql-java-kickstart.github.io/</link><description>Recent content on GraphQL Java Kickstart</description><generator>Hugo</generator><language>en-us</language><lastBuildDate>Mon, 17 May 2021 07:00:00 -0500</lastBuildDate><atom:link href="https://graphql-java-kickstart.github.io/index.xml" rel="self" type="application/rss+xml"/><item><title>Getting started</title><link>https://graphql-java-kickstart.github.io/servlet/getting-started/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/servlet/getting-started/</guid><description>A working version of this example can be found at <a href="https://github.com/graphql-java-kickstart/samples/tree/master/servlet-hello-world">https://github.com/graphql-java-kickstart/samples/tree/master/servlet-hello-world</a>.
<h2 id="build-with-gradle">Build with Gradle</h2>
First you set up a basic build script. You can use any build system you like, but the code you need to work with
Gradle and Maven is included here.
<h3 id="create-a-gradle-build-file">Create a Gradle build file</h3>
Make sure <code>mavenCentral</code> is among your repositories. The example build script below uses <code>org.gretty</code> to provide
a webserver to show a working example.</description></item><item><title>Getting started</title><link>https://graphql-java-kickstart.github.io/spring-boot/getting-started/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/spring-boot/getting-started/</guid><description>This project requires at least the following version:
<ul>
<li>Java 17</li>
<li>Spring Boot 3.x.x (<code>spring-boot-starter-web</code>)</li>
</ul>
<h2 id="quick-start">Quick start</h2>
To add <code>graphql-spring-boot</code> to your project and get started quickly, do the following.
<h3 id="build-with-gradle">Build with Gradle</h3>
Make sure <code>mavenCentral</code> is amongst your repositories:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-gradle" data-lang="gradle">repositories {
 mavenCentral()
}
</code></pre></div>Add the respective starter dependencies you want to use:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-gradle" data-lang="gradle">dependencies {
 implementation &#39;com.graphql-java-kickstart:graphql-spring-boot-starter:15.0.0&#39;

 // testing facilities
 testImplementation &#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:15.0.0&#39;
}
</code></pre></div><h3 id="build-with-maven">Build with Maven</h3>
Add the respective starter dependencies you want to use:</description></item><item><title>Getting started</title><link>https://graphql-java-kickstart.github.io/tools/getting-started/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/tools/getting-started/</guid><description>A working <a href="https://github.com/graphql-java-kickstart/samples/tree/master/tools-hello-world">Java Spring-Boot application</a> is provided,
based off the <a href="https://github.com/graphql-java/graphql-java/blob/master/src/test/groovy/graphql/StarWarsSchema.java">Star Wars API</a> tests
and <a href="https://github.com/graphql-java/graphql-java/blob/master/src/test/groovy/graphql/StarWarsData.groovy">test data</a>.
If you&rsquo;re using Spring Boot, check out the <a href="https://github.com/graphql-java-kickstart/graphql-spring-boot">graphql-spring-boot-starter</a>!
A working <a href="https://github.com/graphql-java-kickstart/graphql-java-tools/blob/master/src/test/kotlin/graphql/kickstart/tools/EndToEndSpecHelper.kt">Kotlin example</a> can be found in the tests.
<h2 id="quick-start">Quick start</h2>
To add <code>graphql-java-tools</code> to your project and get started quickly, do the following.
<h3 id="build-with-gradle">Build with Gradle</h3>
Make sure <code>mavenCentral</code> is amongst your repositories:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-gradle" data-lang="gradle">repositories {
 mavenCentral()
}
</code></pre></div>Add the <code>graphql-java-tools</code> dependency:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-gradle" data-lang="gradle">dependencies {
 implementation &#39;io.github.graphql-java-kickstart:graphql-java-tools:14.3.0&#39;
}
</code></pre></div><h3 id="build-with-maven">Build with Maven</h3>
Add the <code>graphql-java-tools</code> dependency:</description></item><item><title>Dataloaders</title><link>https://graphql-java-kickstart.github.io/servlet/dataloaders/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/servlet/dataloaders/</guid><description>It is possible to create context, and consequently dataloaders, in both a request scope and a per query scope by
customizing <a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-kickstart/src/main/java/graphql/kickstart/execution/context/GraphQLContextBuilder.java">GraphQLContextBuilder</a>
and selecting the appropriate <a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-kickstart/src/main/java/graphql/kickstart/execution/context/ContextSetting.java">ContextSetting</a>
with the provided <a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/GraphQLConfiguration.java">GraphQLConfiguration</a>.
A new <a href="https://github.com/graphql-java/java-dataloader/blob/master/src/main/java/org/dataloader/DataLoaderRegistry.java">DataLoaderRegistry</a> should be created in each call to the GraphQLContextBuilder, and the servlet will call the builder at the appropriate times.
For example:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">public class CustomGraphQLContextBuilder implements GraphQLServletContextBuilder {

 private final DataLoader userDataLoader;
 
 public CustomGraphQLContextBuilder(DataLoader userDataLoader) {
 this.userDataLoader = userDataLoader;
 }
 
 public GraphQLContext build() {
 return new DefaultGraphQLContext();
 }
 
 public GraphQLContext build(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) {
 return DefaultGraphQLServletContext.createServletContext()
 .with(httpServletRequest)
 .with(httpServletResponse)
 .with(buildDataLoaderRegistry())
 .build();
 }
 
 public GraphQLContext build(Session session, HandshakeRequest handshakeRequest) {
 return DefaultGraphQLWebSocketContext.createWebSocketContext()
 .with(session)
 .with(handshakeRequest)
 .with(buildDataLoaderRegistry())
 .build();
 }
 
 private DataLoaderRegistry buildDataLoaderRegistry() {
 DataLoaderRegistry registry = new DataLoaderRegistry();
 registry.register(&#34;userDataLoader&#34;, userDataLoader);
 return registry;
 }
}
</code></pre></div>It is then possible to access the <a href="https://github.com/graphql-java/java-dataloader/blob/master/src/main/java/org/dataloader/DataLoader.java">DataLoader</a>
in the resolvers by accessing the <a href="https://github.com/graphql-java/java-dataloader/blob/master/src/main/java/org/dataloader/DataLoaderRegistry.java">DataLoaderRegistry</a> from context. For example:</description></item><item><title>Defining a schema</title><link>https://graphql-java-kickstart.github.io/tools/schema-definition/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/tools/schema-definition/</guid><description>A <a href="http://graphql.org/learn/schema/">GraphQL schema</a> can be given either as raw strings:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">// My application class
SchemaParser.newParser()
 .schemaString(&#34;Query { }&#34;)
</code></pre></div>or as files on the classpath:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">// My application class
SchemaParser.newParser()
 .file(&#34;my-schema.graphqls&#34;)

// my-schema.graphqls
Query { }
</code></pre></div>Multiple sources will be concatenated together in the order given, allowing you to modularize your schema if desired.
Line numbers in syntax errors count from the start of each file or string, and errors in a file end with its name. To name a schema string too, pass the name as well:</description></item><item><title>Servlet Listener</title><link>https://graphql-java-kickstart.github.io/servlet/servlet-listener/</link><pubDate>Fri, 15 May 2020 09:28:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/servlet/servlet-listener/</guid><description>The GraphQL Servlet library allows you to add a <a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/core/GraphQLServletListener.java">Servlet Listener</a>
for listening to the GraphQL request. It provides hooks into the servlet request execution (success, error, and finally):
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">public class MyServlet extends GraphQLHttpServlet {

 @Override
 protected GraphQLConfiguration getConfiguration() {
 return GraphQLConfiguration.with(createSchema())
 .with(queryInvoker)
 .with(Arrays.asList(listener))
 .build();
 }
}
</code></pre></div><h2 id="instrumentation">Instrumentation</h2>
The Servlet Listener listens to the servlet request, but not to the GraphQL query execution.
If you want to listen to that you should use the <a href="https://www.graphql-java.com/documentation/v16/instrumentation/">Instrumentation</a>
provided by GraphQL Java. You can extend <a href="https://github.com/graphql-java/graphql-java/blob/master/src/main/java/graphql/execution/instrumentation/SimpleInstrumentation.java">SimpleInstrumentation</a>
to quickly create a custom implementation and use it when creating the <code>GraphQLConfiguration</code>.</description></item><item><title>Schema parser options</title><link>https://graphql-java-kickstart.github.io/tools/schema-parser-options/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/tools/schema-parser-options/</guid><description>For advanced use-cases, the schema parser can be tweaked to suit your needs.
Use <code>SchemaParserOptions.newBuilder()</code> to build an options object to pass to the parser.
Options:
<ul>
<li>
<code>contextClass</code>: If you use a custom context object to execute your queries, let the parser know about it so that it can add it to data fetchers as an argument. 
Make sure to also provide your context instance to the execution input:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">var executionInput = ExecutionInput.newExecutionInput()
 .query(query)
 .variables(variables)
 .graphQLContext(Map.of(CustomContext.class, context));
</code></pre></div></li>
<li>
<code>genericWrappers</code>: Allows defining your own generic classes that should be unwrapped when matching Java types to GraphQL types. You must supply the class and the index (zero-indexed) of the wrapped generic type. For example: If you want to unwrap type argument <code>T</code> of <code>Future&lt;T&gt;</code>, you must pass <code>Future.class</code> and <code>0</code>.
Use <code>GenericWrapper.withTransformer</code> to also convert the value at runtime. If the transformer returns <code>null</code>, the field is <code>null</code>.
</li>
<li>
<code>useDefaultGenericWrappers</code>: Defaults to <code>true</code>. Tells the parser whether or not to add it&rsquo;s own list of well-known generic wrappers, such as <code>Future</code> and <code>CompletableFuture</code>.
graphql-java only waits on a <code>CompletionStage</code>, so a method declared to return a <code>Future</code> has to return one, such as a <code>CompletableFuture</code>. Any other future fails the field with an error, unless a generic wrapper transformer converts it.
</li>
<li>
<code>allowUnimplementedResolvers</code>: Defaults to <code>false</code>. Allows a schema to be created even if not all GraphQL fields have resolvers. Intended only for development, it will log a warning to remind you to turn it off for production. Any unimplemented resolvers will throw errors when queried.
</li>
<li>
<code>missingResolverDataFetcher</code>: Allows you to provide custom behavior for missing GraphQL fields.
</li>
<li>
<code>inputArgumentOptionalDetectOmission</code>: Defaults to <code>false</code>. By default, the parser will treat omitted or null method input arguments as <code>Optional.empty</code> in resolvers. If you prefer, you can disable this behavior.
</li>
<li>
<code>objectMapperConfigurer</code> / <code>objectMapperProvider</code>: Exposes the Jackson <code>ObjectMapper</code> that handles marshalling arguments in method resolvers. Every method resolver gets its own mapper, and the configurer can configure it differently based on the GraphQL field definition.
</li>
<li>
<code>preferGraphQLResolver</code>: In cases where you have a Resolver class and legacy class that conflict on type arguments, use the Resolver class instead of throwing an error.
Specifically this situation can occur when you have a graphql schema type <code>Foo</code> with a <code>bars</code> property and classes:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">// legacy class you can&#39;t change
class Foo {
 Set&lt;Bar&gt; getBars() {
 //...returns set of bars...
 }
}

// nice resolver that does what you want
class FooResolver implements GraphQLResolver&lt;Foo&gt; {
 Set&lt;BarDTO&gt; getBars() {
 // ...converts Bar objects to BarDTO objects and returns set...
 }
}
</code></pre></div>You will now have the code find two different return types for getBars() and application will not start with the error <code>Caused by: graphql.kickstart.tools.SchemaClassScannerError: Two different classes used for type</code>
If this property is true it will ignore the legacy version.
</li>
<li>
<code>addProxyHandler</code>: If your runtime resolver classes are auto-generated proxies of some kind you can provide a handler to help the parser find the real resolvers behind them. Four proxy handlers are provided by default for these libraries:
<ul>
<li>Javassist</li>
<li>Guice</li>
<li>Spring AOP</li>
<li>Weld</li>
</ul>
</li>
<li>
<code>introspectionEnabled</code>: Defaults to <code>true</code>. When set to <code>false</code> this option will disable schema introspection via <code>NO_INTROSPECTION_FIELD_VISIBILITY</code>. See <a href="https://www.graphql-java.com/documentation/field-visibility">Field Visibility</a>.
</li>
<li>
<code>fieldVisibility</code>: Provide a graphql field visibility implementation. This option overrides <code>introspectionEnabled</code> when used. See <a href="https://www.graphql-java.com/documentation/field-visibility">Field Visibility</a>.
</li>
<li>
<code>coroutineContext</code> / <code>coroutineContextProvider</code>: Provide a kotlin coroutine context to be used with suspend functions of resolvers.
A suspend function runs on the calling thread until it first suspends, and continues on this context after that, so wrap blocking calls in <code>withContext(Dispatchers.IO)</code>.
To run them in your own <code>CoroutineScope</code>, e.g. to cancel them with the request, put it in the execution input&rsquo;s context:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-java" data-lang="java">var executionInput = ExecutionInput.newExecutionInput()
 .query(query)
 .graphQLContext(Map.of(CoroutineScope.class, scope));
</code></pre></div></li>
<li>
<code>typeDefinitionFactory</code>: See <a href="https://graphql-java-kickstart.github.io/tools/type-definition-factory/">Type Definition Factory</a>.
</li>
<li>
<code>includeUnusedTypes</code>: Defaults to <code>false</code>. By default, the parser will ignore unused type definitions in the schema. Enable this option to include them regardless.
</li>
<li>
<code>allowUndeclaredDirectives</code>: Defaults to <code>false</code>. Allows applying directives that aren&rsquo;t declared in the schema, e.g. the Apollo Federation directives imported through <code>@link</code>. They&rsquo;re only added as applied directives, with argument types guessed from their values. Directives with enum or input object arguments still have to be declared.
</li>
<li>
<code>unmappedInputFields</code>: Defaults to <code>WARN</code>. What to do about input type fields that the class of a resolver argument has no property for. When a client sends such a field, Jackson fails to convert the argument, or drops the value if the <code>ObjectMapper</code> ignores unknown properties.
The classes are checked when the schema is built, with each field&rsquo;s own <code>ObjectMapper</code>, and <code>WARN</code> logs a warning for each of these fields. <code>FAIL</code> fails the build instead, and <code>IGNORE</code> skips the check. To leave a field unmapped on purpose, add it to <code>@JsonIgnoreProperties</code> on the class.
Classes with a custom deserializer, a builder or a delegating creator aren&rsquo;t checked, and neither are arguments bound to a <code>Map</code> or a <code>JsonNode</code>.
</li>
</ul></description></item><item><title>Relay</title><link>https://graphql-java-kickstart.github.io/tools/relay/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/tools/relay/</guid><description>Relay requires quite some boilerplate type definitions to be defined. They
are all the same apart from type of the node the Relay connection targets.
This results in schemas with a lot of duplication, like the following:
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-graphql" data-lang="graphql">type Query {
 users(first: Int, after: String): UserConnection
 organizations(first: Int, after: String): OrganizationConnection
}

type UserConnection {
 edges: [UserEdge]
 pageInfo: PageInfo
}

type UserEdge {
 cursor: String
 node: User
}

type PageInfo {
 hasPreviousPage: Boolean!
 hasNextPage: Boolean!
}

type User {
 id: ID!
 name: String
}

type OrganizationConnection {
 edges: [OrganizationEdge]
 pageInfo: PageInfo
}

type OrganizationEdge {
 cursor: String
 node: Organization
}

type Organization {
 id: ID!
}
</code></pre></div><h2 id="using-the-type-definition-factory">Using the Type Definition Factory</h2>
In version 5.4 of <code>graphql-java-tools</code> the
<a href="https://graphql-java-kickstart.github.io/tools/type-definition-factory/">Type Definition Factory</a> has been
introduced. This has been added with this particular use case in mind, but can
be used for any type of definition that you&rsquo;d want to add dynamically instead
of defining it statically in the SDL.</description></item><item><title>Type Definition Factory</title><link>https://graphql-java-kickstart.github.io/spring-boot/type-definition-factory/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/spring-boot/type-definition-factory/</guid><description>The Type Definition Factory has been added with to be able to dynamically
add type definitions to the schema instead of having to define them manually
in the SDL. There are a couple of use cases where the types that have to be defined
are very much alike and only certain parts are different. For example the
connection and edge types used by <a href="https://graphql-java-kickstart.github.io/tools/relay/">Relay</a>. Since generics isn&rsquo;t supported in
the definition language this type definition factory has been added.</description></item><item><title>Type Definition Factory</title><link>https://graphql-java-kickstart.github.io/tools/type-definition-factory/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/tools/type-definition-factory/</guid><description>The Type Definition Factory has been added to allow to dynamically
add type definitions to the schema instead of having to define them manually
in the SDL. There are a couple of use cases where the types that have to be defined
are very much alike and only certain parts are different. For example the
connection and edge types used by <a href="https://graphql-java-kickstart.github.io/tools/relay/">Relay</a>. Since generics aren&rsquo;t supported in
the definition language this type definition factory has been added.</description></item><item><title>Directives</title><link>https://graphql-java-kickstart.github.io/spring-boot/directives/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/spring-boot/directives/</guid><description>See <a href="https://www.graphql-java.com/documentation/v16/sdl-directives/">Schema Directives</a>
for a detailed explanation about directives including examples on how to define
them in the SDL and to create the required classes.
To add your custom <code>SchemaDirectiveWiring</code> to <code>graphql-spring-boot</code> create a bean
of type <code>SchemaDirective</code> to have it automatically passed along to the <code>SchemaParser</code>
<pre tabindex="0"><code>SchemaDirective.create(&#34;uppercase&#34;, new UppercaseDirective())
</code></pre><h2 id="basic-usage">Basic usage</h2>
Let&rsquo;s say you defined a custom directive to make text uppercase in a resource <code>schema.graphqls</code>:
<pre tabindex="0"><code>directive @uppercase on FIELD_DEFINITION

type Query {
 hello: String @uppercase
}
</code></pre>And the actual implementation is the following:</description></item><item><title>Directives</title><link>https://graphql-java-kickstart.github.io/tools/directives/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/tools/directives/</guid><description>See <a href="https://www.graphql-java.com/documentation/directives">Schema Directives</a>
for a detailed explanation about directives including examples on how to define
them in the SDL and to create the required classes.
To add your custom <code>SchemaDirectiveWiring</code> to <code>graphql-java-tools</code> pass it along
when creating the <code>SchemaParser</code> using
<pre tabindex="0"><code>SchemaParser.newParser().directive(&#34;name&#34;, new MySchemaDirectiveWiring()).build()
</code></pre><h2 id="basic-usage">Basic usage</h2>
Let&rsquo;s say you defined a custom directive to make text uppercase in a resource <code>schema.graphqls</code>:
<pre tabindex="0"><code>directive @uppercase on FIELD_DEFINITION

type Query {
 hello: String @uppercase
}
</code></pre>And the actual implementation is the following:</description></item><item><title>Embedded Editors</title><link>https://graphql-java-kickstart.github.io/spring-boot/embedded-editors/</link><pubDate>Mon, 17 May 2021 07:00:00 -0500</pubDate><guid>https://graphql-java-kickstart.github.io/spring-boot/embedded-editors/</guid><description>The following GraphQL Embedded Editors are bundled for convenience:
<ul>
<li><a href="#altair">Altair</a>
<ul>
<li><a href="#configuration-parameters">Configuration Parameters</a></li>
</ul>
</li>
<li><a href="#graphql-playground">GraphQL Playground</a>
<ul>
<li><a href="#configuration-parameters-1">Configuration Parameters</a></li>
</ul>
</li>
<li><a href="#graphiql">GraphiQL</a>
<ul>
<li><a href="#configuration-parameters-2">Configuration Parameters</a></li>
</ul>
</li>
<li><a href="#graphql-voyager">GraphQL Voyager</a>
<ul>
<li><a href="#configuration-parameters-3">Configuration Parameters</a></li>
</ul>
</li>
</ul>
<h2 id="altair">Altair</h2>
<a href="https://github.com/imolorhe/altair">Altair</a> becomes accessible at the root <code>/altair</code> if the <code>graphql.altair.enabled</code> property is true.
Note that GraphQL server must be available at <code>/graphql/\*</code> context to be discovered by Altair.
<h3 id="configuration-parameters">Configuration Parameters</h3>
Available Spring Boot configuration parameters (either <code>application.yml</code> or <code>application.properties</code>):
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-yaml" data-lang="yaml">graphql:
 altair:
 enabled: true
 mapping: /altair
 subscriptions:
 timeout: 30
 reconnect: false
 static:
 base-path: /
 page-title: Altair
 cdn:
 enabled: false
 version: 4.0.2
 options:
 endpoint-url: /graphql
 subscriptions-endpoint: /subscriptions
 initial-settings:
 theme: dracula
 initial-headers:
 Authorization: &#34;Bearer &lt;your-token&gt;&#34;
 resources:
 initial-query: defaultQuery.graphql
 initial-variables: variables.graphql
 initial-pre-request-script: pre-request.graphql
 initial-post-request-script: post-request.graphql
</code></pre></div><h2 id="graphql-playground">GraphQL Playground</h2>
<a href="https://github.com/prisma/graphql-playground">GraphQL Playground</a> becomes accessible at root <code>/playground</code> (or as configured in <code>graphql.playground.mapping</code>) if the <code>graphql.playground.enabled</code> property is true.</description></item><item><title>OSGi</title><link>https://graphql-java-kickstart.github.io/servlet/osgi/</link><pubDate>Fri, 15 May 2020 09:28:02 +0100</pubDate><guid>https://graphql-java-kickstart.github.io/servlet/osgi/</guid><description>The <a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/OsgiGraphQLHttpServlet.java">OsgiGraphQLHttpServlet</a> uses a &ldquo;provider&rdquo; model to supply the servlet with the required objects:
<ul>
<li><a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/osgi/GraphQLQueryProvider.java">GraphQLQueryProvider</a>: Provides query fields to the GraphQL schema.</li>
<li><a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/osgi/GraphQLMutationProvider.java">GraphQLMutationProvider</a>: Provides mutation fields to the GraphQL schema.</li>
<li><a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/osgi/GraphQLTypesProvider.java">GraphQLTypesProvider</a>: Provides type information to the GraphQL schema.</li>
<li><a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-kickstart/src/main/java/graphql/kickstart/execution/config/ExecutionStrategyProvider.java">ExecutionStrategyProvider</a>: Provides an execution strategy for running each query.</li>
<li><a href="https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/context/GraphQLServletContextBuilder.java">GraphQLContextBuilder</a>: Builds a context for running each query.</li>
</ul>
<h2 id="examples">Examples</h2>
You can now find some example on how to use graphql-java-servlet.
<h3 id="requirements">Requirements</h3>
The OSGi examples use Maven as a build tool because it requires plugins that are not (yet) available for Gradle.
Therefore you will need Maven 3.2+.</description></item></channel></rss>

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Repository navigation

index.xml

index.xml

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

index.xml

Latest commit

History

index.xml

File metadata and controls