Skip to content

Commit 3005bdc

Browse files
committed
(docs) Update latest versions
1 parent c315993 commit 3005bdc

File tree

2 files changed

+37
-26
lines changed

2 files changed

+37
-26
lines changed

content/servlet/_index.md

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,14 @@ menu:
1414
[![GitHub contributors](https://img.shields.io/github/contributors/graphql-java-kickstart/graphql-java-servlet)](https://github.com/graphql-java-kickstart/graphql-java-servlet/graphs/contributors)
1515
[![Discuss on GitHub](https://img.shields.io/badge/GitHub-discuss-orange)](https://github.com/graphql-java-kickstart/graphql-java-servlet/discussions)
1616

17-
1817
Implementation of GraphQL Java Servlet including support for Relay.js, Apollo and OSGi out of the box.
1918
This project wraps the Java implementation of GraphQL provided by [GraphQL Java](https://www.graphql-java.com).
2019
The documentation on this site focuses around the usage of the servlet. Although some parts may dive deeper
2120
into the aspects of GraphQL Java as well, make sure to look at the
2221
[GraphQL Java documentation](https://www.graphql-java.com/documentation/latest/) for more in depth details
2322
regarding GraphQL Java itself.
2423

25-
We try to stay up to date with GraphQL Java as much as possible. The current version supports **GraphQL Java 16.1**.
24+
We try to stay up to date with GraphQL Java as much as possible. The current version supports **GraphQL Java 17.3**.
2625

2726
This project requires at least Java 8.
2827

@@ -35,27 +34,30 @@ To add `graphql-java-servlet` to your project and get started quickly, do the fo
3534
### Build with Gradle
3635

3736
Make sure `mavenCentral` is amongst your repositories:
37+
3838
```gradle
3939
repositories {
4040
mavenCentral()
4141
}
4242
```
4343

4444
Add the `graphql-java-servlet` dependency:
45+
4546
```gradle
4647
dependencies {
47-
compile 'com.graphql-java-kickstart:graphql-java-servlet:11.1.0'
48+
compile 'com.graphql-java-kickstart:graphql-java-servlet:12.0.0'
4849
}
4950
```
5051

5152
### Build with Maven
5253

5354
Add the `graphql-java-servlet` dependency:
55+
5456
```xml
5557
<dependency>
5658
<groupId>com.graphql-java-kickstart</groupId>
5759
<artifactId>graphql-java-servlet</artifactId>
58-
<version>11.1.0</version>
60+
<version>12.0.0</version>
5961
</dependency>
6062
```
6163

@@ -73,6 +75,7 @@ Snapshot versions of the current `master` branch are availble on JFrog. Check th
7375
### Build with Gradle
7476

7577
Add the Snapshot repository:
78+
7679
```gradle
7780
repositories {
7881
mavenCentral()
@@ -83,6 +86,7 @@ repositories {
8386
### Build with Maven
8487

8588
Add the Snapshot repository:
89+
8690
```xml
8791
<repositories>
8892
<repository>
@@ -98,27 +102,29 @@ Add the Snapshot repository:
98102
```
99103

100104
## Usage
101-
105+
102106
The servlet supports the following request formats:
103-
* GET request to `../schema.json`: Get the result of an introspection query.
104-
* GET request with query parameters (query only, no mutation):
105-
* query
106-
* operationName (optional)
107-
* variables (optional)
108-
* POST body JSON object with fields:
109-
* query
110-
* operationName (optional)
111-
* variables (optional)
112-
* POST multipart part named "graphql" containing JSON object with fields:
113-
* query
114-
* operationName (optional)
115-
* variables (optional)
116-
* POST multipart parts named "query", "operationName" (optional), and "variables" (optional)
117-
* POST with Content Type "application/graphql" will treat the HTTP POST body contents as the GraphQL query string
118-
107+
108+
- GET request to `../schema.json`: Get the result of an introspection query.
109+
- GET request with query parameters (query only, no mutation):
110+
- query
111+
- operationName (optional)
112+
- variables (optional)
113+
- POST body JSON object with fields:
114+
- query
115+
- operationName (optional)
116+
- variables (optional)
117+
- POST multipart part named "graphql" containing JSON object with fields:
118+
- query
119+
- operationName (optional)
120+
- variables (optional)
121+
- POST multipart parts named "query", "operationName" (optional), and "variables" (optional)
122+
- POST with Content Type "application/graphql" will treat the HTTP POST body contents as the GraphQL query string
123+
119124
## Spring Framework support
120125

121126
To use the servlet with Spring Framework, either use the [Spring Boot starter](https://www.graphql-java-kickstart.com/spring-boot/) or simply define a `ServletRegistrationBean` in a web app:
127+
122128
```java
123129
@Bean
124130
ServletRegistrationBean graphQLServletRegistrationBean(GraphQLSchema schema, ExecutionStrategy executionStrategy, List<GraphQLOperationListener> operationListeners) {
@@ -128,7 +134,7 @@ ServletRegistrationBean graphQLServletRegistrationBean(GraphQLSchema schema, Exe
128134

129135
## GraphQL Subscription support
130136

131-
Subscriptions over WebSocket are fully supported within Spring Boot, but may require some work if you're using another
132-
framework. There is an example [here](https://github.com/graphql-java-kickstart/samples/tree/master/subscription-with-authentication).
133-
Internally, [JSR 356](https://www.oracle.com/technical-resources/articles/java/jsr356.html) is used for WebSocket
137+
Subscriptions over WebSocket are fully supported within Spring Boot, but may require some work if you're using another
138+
framework. There is an example [here](https://github.com/graphql-java-kickstart/samples/tree/master/subscription-with-authentication).
139+
Internally, [JSR 356](https://www.oracle.com/technical-resources/articles/java/jsr356.html) is used for WebSocket
134140
support. The endpoint is [GraphQLWebSocketServlet](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/38af304a9da1a57ac7475098b7fccec1b063646b/graphql-java-servlet/src/main/java/graphql/kickstart/servlet/GraphQLWebsocketServlet.java).

content/tools/getting-started/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,30 @@ To add `graphql-java-tools` to your project and get started quickly, do the foll
2323
### Build with Gradle
2424

2525
Make sure `mavenCentral` is amongst your repositories:
26+
2627
```gradle
2728
repositories {
2829
mavenCentral()
2930
}
3031
```
3132

3233
Add the `graphql-java-tools` dependency:
34+
3335
```gradle
3436
dependencies {
35-
compile 'com.graphql-java-kickstart:graphql-java-tools:11.0.0'
37+
compile 'com.graphql-java-kickstart:graphql-java-tools:12.0.1'
3638
}
3739
```
3840

3941
### Build with Maven
4042

4143
Add the `graphql-java-tools` dependency:
44+
4245
```xml
4346
<dependency>
4447
<groupId>com.graphql-java-kickstart</groupId>
4548
<artifactId>graphql-java-tools</artifactId>
46-
<version>11.0.0</version>
49+
<version>12.0.1</version>
4750
</dependency>
4851
```
4952

@@ -55,6 +58,7 @@ Snapshot versions of the current `master` branch are available on JFrog. Check t
5558
### Build with Gradle
5659

5760
Add the Snapshot repository:
61+
5862
```gradle
5963
repositories {
6064
mavenCentral()
@@ -65,6 +69,7 @@ repositories {
6569
### Build with Maven
6670

6771
Add the Snapshot repository:
72+
6873
```xml
6974
<repositories>
7075
<repository>

0 commit comments

Comments
 (0)