Skip to content

Commit 0343265

Browse files
committed
1 parent 56ed150 commit 0343265

File tree

5 files changed

+14
-32
lines changed

5 files changed

+14
-32
lines changed

index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

index.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Create a Gradle build file Make sure mavenCentral is among your repositories. Th
44
Java 8 Spring Boot > 2.x.x (spring-boot-starter-web) Quick start To add graphql-spring-boot to your project and get started quickly, do the following.
55
Build with Gradle Make sure mavenCentral is amongst your repositories:
66
repositories { mavenCentral() } Add the respective starter dependencies you want to use:
7-
dependencies { compile &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter:11.0.0&amp;#39; compile &amp;#39;com.graphql-java-kickstart:graphiql-spring-boot-starter:11.0.0&amp;#39; compile &amp;#39;com.graphql-java-kickstart:voyager-spring-boot-starter:11.0.0&amp;#39; testCompile &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:11.0.0&amp;#39; } Build with Maven Add the respective starter dependencies you want to use:</description></item><item><title>Getting started</title><link>https://www.graphql-java-kickstart.com/tools/getting-started/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://www.graphql-java-kickstart.com/tools/getting-started/</guid><description>A working Java Spring-Boot application is provided, based off the Star Wars API tests and test data. If you&amp;rsquo;re using Spring Boot, check out the graphql-spring-boot-starter!
7+
dependencies { implementation &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter:12.0.0&amp;#39; // testing facilities testImplementation &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:12.0.0&amp;#39; } Build with Maven Add the respective starter dependencies you want to use:</description></item><item><title>Getting started</title><link>https://www.graphql-java-kickstart.com/tools/getting-started/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://www.graphql-java-kickstart.com/tools/getting-started/</guid><description>A working Java Spring-Boot application is provided, based off the Star Wars API tests and test data. If you&amp;rsquo;re using Spring Boot, check out the graphql-spring-boot-starter!
88
A working Kotlin example can be found in the tests.
99
Quick start To add graphql-java-tools to your project and get started quickly, do the following.
1010
Build with Gradle Make sure mavenCentral is amongst your repositories:

spring-boot/getting-started/index.html

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,22 @@
1010
mavenCentral<span style=color:#f92672>()</span>
1111
<span style=color:#f92672>}</span>
1212
</code></pre></div><p>Add the respective starter dependencies you want to use:</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-gradle data-lang=gradle>dependencies <span style=color:#f92672>{</span>
13-
compile <span style=color:#e6db74>&#39;com.graphql-java-kickstart:graphql-spring-boot-starter:11.0.0&#39;</span>
14-
compile <span style=color:#e6db74>&#39;com.graphql-java-kickstart:graphiql-spring-boot-starter:11.0.0&#39;</span>
15-
compile <span style=color:#e6db74>&#39;com.graphql-java-kickstart:voyager-spring-boot-starter:11.0.0&#39;</span>
16-
testCompile <span style=color:#e6db74>&#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:11.0.0&#39;</span>
13+
implementation <span style=color:#e6db74>&#39;com.graphql-java-kickstart:graphql-spring-boot-starter:12.0.0&#39;</span>
14+
15+
<span style=color:#75715e>// testing facilities
16+
</span><span style=color:#75715e></span> testImplementation <span style=color:#e6db74>&#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:12.0.0&#39;</span>
1717
<span style=color:#f92672>}</span>
1818
</code></pre></div><h3 id=build-with-maven>Build with Maven</h3><p>Add the respective starter dependencies you want to use:</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=color:#f92672>&lt;dependency&gt;</span>
1919
<span style=color:#f92672>&lt;groupId&gt;</span>com.graphql-java-kickstart<span style=color:#f92672>&lt;/groupId&gt;</span>
2020
<span style=color:#f92672>&lt;artifactId&gt;</span>graphql-spring-boot-starter<span style=color:#f92672>&lt;/artifactId&gt;</span>
21-
<span style=color:#f92672>&lt;version&gt;</span>11.0.0<span style=color:#f92672>&lt;/version&gt;</span>
22-
<span style=color:#f92672>&lt;/dependency&gt;</span>
23-
<span style=color:#f92672>&lt;dependency&gt;</span>
24-
<span style=color:#f92672>&lt;groupId&gt;</span>com.graphql-java-kickstart<span style=color:#f92672>&lt;/groupId&gt;</span>
25-
<span style=color:#f92672>&lt;artifactId&gt;</span>graphiql-spring-boot-starter<span style=color:#f92672>&lt;/artifactId&gt;</span>
26-
<span style=color:#f92672>&lt;version&gt;</span>11.0.0<span style=color:#f92672>&lt;/version&gt;</span>
27-
<span style=color:#f92672>&lt;/dependency&gt;</span>
28-
<span style=color:#f92672>&lt;dependency&gt;</span>
29-
<span style=color:#f92672>&lt;groupId&gt;</span>com.graphql-java-kickstart<span style=color:#f92672>&lt;/groupId&gt;</span>
30-
<span style=color:#f92672>&lt;artifactId&gt;</span>playground-spring-boot-starter<span style=color:#f92672>&lt;/artifactId&gt;</span>
31-
<span style=color:#f92672>&lt;version&gt;</span>11.0.0<span style=color:#f92672>&lt;/version&gt;</span>
32-
<span style=color:#f92672>&lt;/dependency&gt;</span>
33-
<span style=color:#f92672>&lt;dependency&gt;</span>
34-
<span style=color:#f92672>&lt;groupId&gt;</span>com.graphql-java-kickstart<span style=color:#f92672>&lt;/groupId&gt;</span>
35-
<span style=color:#f92672>&lt;artifactId&gt;</span>voyager-spring-boot-starter<span style=color:#f92672>&lt;/artifactId&gt;</span>
36-
<span style=color:#f92672>&lt;version&gt;</span>11.0.0<span style=color:#f92672>&lt;/version&gt;</span>
21+
<span style=color:#f92672>&lt;version&gt;</span>12.0.0<span style=color:#f92672>&lt;/version&gt;</span>
3722
<span style=color:#f92672>&lt;/dependency&gt;</span>
23+
24+
<span style=color:#75715e>&lt;!-- testing facilities --&gt;</span>
3825
<span style=color:#f92672>&lt;dependency&gt;</span>
3926
<span style=color:#f92672>&lt;groupId&gt;</span>com.graphql-java-kickstart<span style=color:#f92672>&lt;/groupId&gt;</span>
4027
<span style=color:#f92672>&lt;artifactId&gt;</span>graphql-spring-boot-starter-test<span style=color:#f92672>&lt;/artifactId&gt;</span>
41-
<span style=color:#f92672>&lt;version&gt;</span>11.0.0<span style=color:#f92672>&lt;/version&gt;</span>
28+
<span style=color:#f92672>&lt;version&gt;</span>12.0.0<span style=color:#f92672>&lt;/version&gt;</span>
4229
<span style=color:#f92672>&lt;scope&gt;</span>test<span style=color:#f92672>&lt;/scope&gt;</span>
4330
<span style=color:#f92672>&lt;/dependency&gt;</span>
4431
</code></pre></div><h2 id=using-the-latest-development-build>Using the latest development build</h2><p>Snapshot versions of the current <code>master</code> branch are available on JFrog. Check the next snapshot version on

spring-boot/index.html

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,11 @@
1010
<a href="https://github.com/graphql-java-kickstart/graphql-spring-boot/actions/workflows/ci.yml?query=workflow%3ACI+branch%3Amaster"><img src="https://github.com/graphql-java-kickstart/graphql-spring-boot/actions/workflows/ci.yml/badge.svg?branch=master" alt="GitHub CI Workflow"></a>
1111
<a href="https://sonarcloud.io/dashboard?id=graphql-java-kickstart_graphql-spring-boot"><img src="https://sonarcloud.io/api/project_badges/measure?project=graphql-java-kickstart_graphql-spring-boot&metric=alert_status" alt="Quality Gate Status"></a>
1212
<a href=https://github.com/graphql-java-kickstart/graphql-spring-boot/graphs/contributors><img src=https://img.shields.io/github/contributors/graphql-java-kickstart/graphql-spring-boot alt="GitHub contributors"></a>
13-
<a href=https://github.com/graphql-java-kickstart/graphql-spring-boot/discussions><img src=https://img.shields.io/badge/GitHub-discuss-orange alt="Discuss on GitHub"></a></p><p>This library contains various Spring Boot starters to enable GraphQL related
13+
<a href=https://github.com/graphql-java-kickstart/graphql-spring-boot/discussions><img src=https://img.shields.io/badge/GitHub-discuss-orange alt="Discuss on GitHub"></a></p><p>This library contains two Spring Boot starters to enable GraphQL related
1414
services or features.</p><h2 id=starters>Starters</h2><ul><li><p><strong>graphql-spring-boot-starter</strong>: turns your Spring Boot application into
1515
a GraphQL Server using <a href=https://www.graphql-java-kickstart.com/servlet/getting-started/>GraphQL Servlet</a>
16-
and <a href=https://www.graphql-java-kickstart.com/tools/>GraphQL Java Tools</a></p></li><li><p><strong>graphql-kickstart-spring-boot-starter-graphql-annotations</strong>: turns your Spring Boot application into
17-
a GraphQL Server using <a href=https://www.graphql-java-kickstart.com/servlet/getting-started/>GraphQL Servlet</a>
18-
and <a href=https://github.com/Enigmatis/graphql-java-annotations>GraphQL-Java Annotations</a></p></li><li><p><strong>graphiql-spring-boot-starter</strong>: embeds the <strong>GraphiQL</strong> tool for schema
19-
introspection and query debugging (see <a href=https://github.com/graphql/graphiql>GraphiQL</a>)</p></li><li><p><strong>playground-spring-boot-starter</strong>: embeds the <strong>GraphQL Playground</strong> tool for schema
20-
introspection and query debugging (see <a href=https://github.com/prisma/graphql-playground>GraphQL Playground</a>)</p></li><li><p><strong>graphql-spring-boot-starter-test</strong>: adds testing capabilities to your project,
21-
like the <code>@GraphQLTest</code> annotation which is comparable to <code>@SpringBootTest</code></p></li><li><p><strong>voyager-spring-boot-starter</strong>: embed the <strong>Voyager</strong> tool to represent your
22-
GraphQL API as an interactive graph (see <a href=https://github.com/APIs-guru/graphql-voyager>Voyager</a>)</p></li></ul></article></div></main><footer class=md-footer><div class="md-footer-meta md-typeset"><div class="md-footer-meta__inner md-grid"><div class=md-footer-copyright><div class=md-footer-copyright__highlight>Released under the Apache 2.0 license</div>powered by
16+
and <a href=https://www.graphql-java-kickstart.com/tools/>GraphQL Java Tools</a></p></li><li><p><strong>graphql-spring-boot-starter-test</strong>: adds testing capabilities to your project,
17+
like the <code>@GraphQLTest</code> annotation which is comparable to <code>@SpringBootTest</code></p></li></ul></article></div></main><footer class=md-footer><div class="md-footer-meta md-typeset"><div class="md-footer-meta__inner md-grid"><div class=md-footer-copyright><div class=md-footer-copyright__highlight>Released under the Apache 2.0 license</div>powered by
2318
<a href=https://gohugo.io>Hugo</a>
2419
and
2520
<a href=https://github.com/oliemansm/hugo-material-docs>Material Docs for Hugo</a></div><div class=md-footer-social><link rel=stylesheet type=text/css href=https://www.graphql-java-kickstart.com/fonts/font-awesome.css><a href=https://github.com/graphql-java-kickstart target=_blank class="md-footer-social__link fa fa-github-alt"></a></div></div></div></footer></div><script>var base_url='https://www.graphql-java-kickstart.com/',repo_id='graphql-java-kickstart'</script><script src=https://www.graphql-java-kickstart.com/javascripts/application.js></script><script src=//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js></script><script>hljs.registerLanguage("graphql",function(a){return{aliases:["gql"],k:{keyword:"query mutation subscription|10 type input schema directive interface union scalar fragment|10 enum on ...",literal:"true false null"},c:[a.HCM,a.QSM,a.NM,{cN:"type",b:"[^\\w][A-Z][a-z]",e:"\\W",eE:!0},{cN:"literal",b:"[^\\w][A-Z][A-Z]",e:"\\W",eE:!0},{cN:"variable",b:"\\$",e:"\\W",eE:!0},{cN:"keyword",b:"[.]{2}",e:"\\."},{cN:"meta",b:"@",e:"\\W",eE:!0}],i:/([;<']|BEGIN)/}}),hljs.initHighlightingOnLoad()</script><script>app.initialize({version:"1.0.4",url:{base:"https://www.graphql-java-kickstart.com/"}})</script></body></html>

spring-boot/index.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Java 8 Spring Boot &amp;gt; 2.x.x (spring-boot-starter-web) Quick start To add graphql-spring-boot to your project and get started quickly, do the following.
33
Build with Gradle Make sure mavenCentral is amongst your repositories:
44
repositories { mavenCentral() } Add the respective starter dependencies you want to use:
5-
dependencies { compile &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter:11.0.0&amp;#39; compile &amp;#39;com.graphql-java-kickstart:graphiql-spring-boot-starter:11.0.0&amp;#39; compile &amp;#39;com.graphql-java-kickstart:voyager-spring-boot-starter:11.0.0&amp;#39; testCompile &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:11.0.0&amp;#39; } Build with Maven Add the respective starter dependencies you want to use:</description></item><item><title>Type Definition Factory</title><link>https://www.graphql-java-kickstart.com/spring-boot/type-definition-factory/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://www.graphql-java-kickstart.com/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 Relay. Since generics isn&amp;rsquo;t supported in the definition language this type definition factory has been added.</description></item><item><title>Directives</title><link>https://www.graphql-java-kickstart.com/spring-boot/directives/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://www.graphql-java-kickstart.com/spring-boot/directives/</guid><description>See Schema Directives for a detailed explanation about directives including examples on how to define them in the SDL and to create the required classes.
5+
dependencies { implementation &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter:12.0.0&amp;#39; // testing facilities testImplementation &amp;#39;com.graphql-java-kickstart:graphql-spring-boot-starter-test:12.0.0&amp;#39; } Build with Maven Add the respective starter dependencies you want to use:</description></item><item><title>Type Definition Factory</title><link>https://www.graphql-java-kickstart.com/spring-boot/type-definition-factory/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://www.graphql-java-kickstart.com/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 Relay. Since generics isn&amp;rsquo;t supported in the definition language this type definition factory has been added.</description></item><item><title>Directives</title><link>https://www.graphql-java-kickstart.com/spring-boot/directives/</link><pubDate>Wed, 07 Nov 2018 00:11:02 +0100</pubDate><guid>https://www.graphql-java-kickstart.com/spring-boot/directives/</guid><description>See Schema Directives for a detailed explanation about directives including examples on how to define them in the SDL and to create the required classes.
66
To add your custom SchemaDirectiveWiring to graphql-spring-boot create a bean of type SchemaDirective to have it automatically passed along to the SchemaParser
77
SchemaDirective.create(&amp;quot;uppercase&amp;quot;, new UppercaseDirective()) Basic usage Let&amp;rsquo;s say you defined a custom directive to make text uppercase in a resource schema.graphqls:
88
directive @uppercase on FIELD_DEFINITION type Query { hello: String @uppercase } And the actual implementation is the following:</description></item><item><title>Embedded Editors</title><link>https://www.graphql-java-kickstart.com/spring-boot/embedded-editors/</link><pubDate>Mon, 17 May 2021 07:00:00 -0500</pubDate><guid>https://www.graphql-java-kickstart.com/spring-boot/embedded-editors/</guid><description>The following GraphQL Embedded Editors are bundled for convenience:

0 commit comments

Comments
 (0)