├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── LICENSE ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src └── main ├── java └── com │ └── creactiviti │ └── spring │ └── boot │ └── starter │ └── graphql │ ├── Arguments.java │ ├── Fields.java │ ├── GraphQLAutoConfiguration.java │ ├── GraphQLController.java │ ├── MutationBuilder.java │ ├── Ping.java │ ├── QueryBuilder.java │ ├── SpelDataFetcher.java │ ├── SubscriptionBuilder.java │ ├── TypeBuilder.java │ └── Types.java └── resources └── META-INF └── spring.factories /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | !.mvn/wrapper/maven-wrapper.jar 3 | 4 | ### STS ### 5 | .apt_generated 6 | .classpath 7 | .factorypath 8 | .project 9 | .settings 10 | .springBeans 11 | 12 | ### IntelliJ IDEA ### 13 | .idea 14 | *.iws 15 | *.iml 16 | *.ipr 17 | 18 | ### NetBeans ### 19 | nbproject/private/ 20 | build/ 21 | nbbuild/ 22 | dist/ 23 | nbdist/ 24 | .nb-gradle/ -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/runabol/spring-boot-starter-graphql/3432a8e573c34af0a5d3a351586e7f140a91dce8/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.2/apache-maven-3.5.2-bin.zip 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Boot Starter GraphQL 2 | 3 | The aim of this project is to get you easily started with GraphQL running in your Spring Boot based apps. 4 | 5 | This project is based on the fine work made by the folks behind the [graphql-java](https://github.com/graphql-java/graphql-java) library. 6 | 7 | **Note**: To support GraphQL's [subscriptions](http://graphql.org/blog/subscriptions-in-graphql-and-relay/) feature this module depends on Spring 5's WebFlux module and therefore Spring Boot 2. 8 | 9 | # GraphQL Primer 10 | 11 | In its most basic definition, GraphQL is a **query language** for your API. 12 | 13 | Say you have a database of movies and you decide that you want to expose it to app developers through an API. 14 | 15 | One way you could go about it is by using the traditional REST API approach: 16 | 17 | ``` 18 | GET /movies?q=big 19 | 20 | [ 21 | 22 | { 23 | "id":"1", 24 | "title":"Big", 25 | "synopsis":"After a wish turns 12-year-old Josh Baskin into a 30-year-old man...", 26 | "duration":"1h44m", 27 | "images":[{ 28 | "type":"thumbnail", 29 | "url":"http://...", 30 | "resolution":"150x200" 31 | }, 32 | { 33 | "type":"full", 34 | "url":"http://...", 35 | "resolution":"1920x1080" 36 | }], 37 | "genres":[...], 38 | "cast":[ 39 | { 40 | "name":"Tom Hanks", 41 | "role":"..." 42 | } 43 | ] 44 | }, 45 | 46 | { 47 | "id":"2", 48 | "title":"The Big Lebowski", 49 | "synopsis":"Jeff Bridges plays Jeff Lebowski who insists on being called "the Dude,"...", 50 | "duration":"1h57m", 51 | "images":[{ 52 | "type":"thumbnail", 53 | "url":"http://...", 54 | "resolution":"150x200" 55 | }, 56 | { 57 | "type":"full", 58 | "url":"http://...", 59 | "resolution":"1920x1080" 60 | }], 61 | "genres":[...], 62 | "cast":[ 63 | { 64 | "name":"...", 65 | "role":"..." 66 | } 67 | ] 68 | } 69 | 70 | ... 71 | 72 | ] 73 | ``` 74 | 75 | While this approach is totally workable it presents several challenges: 76 | 77 | 1. **Waste**. Let's say the app developers is building a screen that gives a movie listing with a thumbnail of the movie. Since the app developer does not need the movie synopsis, cast, genres etc. they are going to throw away a lot of data that had to be collected and tranferred over the wire. That's a lot of waste. One common way that people used to solve this problem is by introducing a `fields` query parameter to their API where you specify the fields you want to get back. This is an okay approach but comes with a significant amount of complexity to implement in the backend and does not scale very well to nested properties. 78 | 79 | 2. **Lack of standardization**. REST-based APIs are extremely custom from one to the next which means that there is no standard way to interrogate them or explore them. You are at the mercy of the API author to write proper documenations and keep these up to date in order to understand how the API works. 80 | 81 | 3. **Evolution**. In REST world, when you need to add new properties to your response you can either take the chance of adding them and hoping nothing breaks or you can add a `/v2/movies` endpoint and add your properties there. This could quickly get out of hand and adds an additional dimension to your API which you would do great without. 82 | 83 | 4. **Taxing the Backend**. When you create the first version of your API it's typically nice and fast. But as you introduce more database joins, more external calls required for your response and more calculations things start slowing down. This impacts not just the new features of your apps that need the new pieces of data but any festures that use the API. 84 | 85 | ## GraphQL to the rescue 86 | 87 | Alternatively, using GraphQL we expose a single endpoint (typically `/graphql`) which accepts a GraphQL query from the client and responds with the requested data. Here's an example: 88 | 89 | ``` 90 | POST /graphql 91 | 92 | { 93 | getAllMovies { 94 | id // this is a field 95 | title, 96 | image(type:"thumbnail") { // fields can be nested 97 | url 98 | } 99 | } 100 | } 101 | ``` 102 | 103 | ``` 104 | [ 105 | 106 | { 107 | "id":"1", 108 | "title":"Big", 109 | "image:{ 110 | "url":"http://..." 111 | } 112 | }, 113 | 114 | { 115 | "id":"2", 116 | "title":"The Big Lebowski", 117 | "image:{ 118 | "url":"http://..." 119 | } 120 | } 121 | ] 122 | ``` 123 | 124 | What just happened? 125 | 126 | 1. **Waste**. Since we only want to get the movie `id`, `title` and the thumbnail URL for each movie, that's exactly what we are getting back. The most of collecting and transferring the data is completely eliminated. 127 | 128 | 2. **Lack of standardization**. The GraphQL [spec](http://facebook.github.io/graphql/October2016/) provides a commong ground for agreement between API authors and client consumers. This opens the door for tools such as [GraphiQL](https://github.com/graphql/graphiql) and [Voyager](https://github.com/APIs-guru/graphql-voyager) to interrogate GraphQL-based APIs. 129 | 130 | 3. **Evolution**. Since GraphQL clients must *explicitly* request the pieces of information that they want to get back, there is no worry in adding new properties to the API and breaking older clients. 131 | 132 | 4. **Taxing the backend**. Since the client is only asking for exactly what it needs, the backend it free to only perform the necessary calculations and data retrieval operations necessary to fullfill the request. 133 | 134 | GraphQL has many more advantages and features but I hope that this gives you a good sense of what's possible with GraphQL. 135 | 136 | For more information check out the offical [GraphQL](http://graphql.org/) website. 137 | 138 | # Usage 139 | 140 | Add the `spring-boot-starter-graphql` dependency to your Spring Boot app: 141 | 142 | ``` 143 | 144 | com.creactiviti 145 | spring-boot-starter-graphql 146 | 0.0.1-SNAPSHOT 147 | 148 | 149 | 150 | 151 | maven-snapshots 152 | http://oss.sonatype.org/content/repositories/snapshots 153 | default 154 | 155 | false 156 | 157 | 158 | true 159 | 160 | 161 | 162 | ``` 163 | 164 | # Kicking the tires 165 | 166 | `spring-boot-starter-graphql` comes with a built-in `ping` query to test that everything is fine: 167 | 168 | ``` 169 | $ curl -s -X POST -H "Content-Type:application/json" -d '{"query":"{ ping }"}' http://localhost:8080/graphql 170 | 171 | { 172 | "data": { 173 | "ping": "OK" 174 | }, 175 | "errors": [], 176 | "extensions": null 177 | } 178 | ``` 179 | 180 | # Your first GraphQL Query 181 | 182 | ``` 183 | @Component 184 | public class HelloWorld implements QueryBuilder { 185 | 186 | @Override 187 | public void build (Builder aBuilder) { 188 | aBuilder.field(Fields.field("hello") // queries are just fields on the schema's built-in Query type. 189 | .type(Scalars.GraphQLString) 190 | .staticValue("Hi there!")); 191 | } 192 | 193 | } 194 | ``` 195 | 196 | ``` 197 | curl -s -X POST -H "Content-Type:application/json" -d '{"query":"{ hello }"}' http://localhost:8080/graphql 198 | 199 | { 200 | "data": { 201 | "hello": "Hi there!" 202 | }, 203 | "errors": [], 204 | "extensions": null 205 | } 206 | ``` 207 | 208 | # Your second GraphQL query 209 | 210 | OK, let's fetch some data now to make this more interesting: 211 | 212 | ``` 213 | @Component 214 | public class GetAllMoviesQuery implements QueryBuilder { 215 | 216 | @Override 217 | public void build (Builder aBuilder) { 218 | aBuilder.field(Fields.field("getAllMovies") 219 | .type(Types.list(Movie.REF)) // query result type 220 | .argument(Arguments.stringArgument("q")) // query arguments 221 | .dataFetcher((env) -> { 222 | 223 | // in the real-world you would probably 224 | // fetch the data from a database but 225 | // i'm keeping it simple for the example. 226 | // The point is that the data can come from 227 | // anywhere: database, another service, 228 | // calculated on the fly, etc. 229 | 230 | Map movie = new HashMap<>(); 231 | 232 | movie.put("title", "Big"); 233 | movie.put("synopsis", "After a wish turns 12-year-old Josh Baskin into a 30-year-old man..."); 234 | movie.put("duration", "1h44m"); 235 | 236 | return Arrays.asList(movie); 237 | })); 238 | } 239 | 240 | } 241 | ``` 242 | 243 | ``` 244 | @Component 245 | public class Movie implements TypeBuilder { 246 | 247 | public static final String NAME = "Movie"; 248 | public static final GraphQLTypeReference REF = Types.ref(NAME); 249 | 250 | @Override 251 | public GraphQLType build () { 252 | return Types.objectTypeBuilder() 253 | .name(NAME) 254 | .field(Fields.notNull(Fields.stringField("id"))) 255 | .field(Fields.stringField("title")) 256 | .field(Fields.stringField("synopsis")) 257 | .field(Fields.stringField("duration")) 258 | .field(Fields.field("image") 259 | .argument(Arguments.stringArgument("type")) 260 | .type(Image.REF) 261 | .dataFetcher((env) -> { 262 | 263 | // fetch the right image. 264 | 265 | // will NOT be executed if the user 266 | // did not ask for the image field! 267 | 268 | }) 269 | ) 270 | .build(); 271 | } 272 | 273 | } 274 | ``` 275 | 276 | ``` 277 | $ curl -s -X POST -H "Content-Type:application/json" -d '{"query":"{ getAllMovies { title synopsis } }"}' http://localhost:8080/graphql 278 | 279 | { 280 | "data": { 281 | "getAllMovies": [ 282 | { 283 | "title": "Big", 284 | "synopsis": "After a wish turns 12-year-old Josh Baskin into a 30-year-old man..." 285 | } 286 | ] 287 | }, 288 | "errors": [], 289 | "extensions": null 290 | } 291 | ``` 292 | 293 | # Mutations 294 | 295 | So far we looked at reading data from the API. Mutations are GraphQL's approach to writing data. 296 | 297 | ``` 298 | @Component 299 | public class AddMovie implements MutationBuilder { 300 | 301 | @Override 302 | public void build (Builder aBuilder) { 303 | aBuilder.field(Fields.field("addMovie") 304 | .argument(Arguments.notNull(Arguments.stringArgument("title"))) 305 | .argument(Arguments.stringArgument("synopsis")) 306 | .argument(Arguments.stringArgument("duration")) 307 | .type(Movie.REF) 308 | .dataFetcher((env) -> { 309 | Map record = new HashMap<>(); 310 | 311 | record.put("id", UUID.randomUUID().toString().replace("-","")); 312 | record.put("title", env.getArgument("title")); 313 | record.put("synopsis", env.getArgument("synopsis")); 314 | record.put("duration", env.getArgument("duration")); 315 | 316 | // save the the database 317 | 318 | return record; 319 | })); 320 | } 321 | 322 | } 323 | ``` 324 | 325 | ``` 326 | $ curl -s -X POST -H "Content-Type:application/json" -d '{"query":"mutation { addMovie (title:\"Big Fish\") { id title } }"}' http://localhost:8080/graphql 327 | 328 | { 329 | "data": { 330 | "addMovie": { 331 | "id": "8294094ebb034c7f82ef1170b95f69b0", 332 | "title": "Big Fish" 333 | } 334 | }, 335 | "errors": [], 336 | "extensions": null 337 | } 338 | ``` 339 | 340 | 341 | 342 | # Subscriptions 343 | 344 | Both queries and mutations make use of the traditional request/response model: the client makes a request with the specifics of what it wants to get back and the server responds appropriately. 345 | 346 | Subscriptions on the other hand, are publish/subsribe based mechanism: the server published some sort of notifications that clients can subscribe to. 347 | 348 | For example we can let clients know whenever a movie was added: 349 | 350 | ``` 351 | @Component 352 | public class MovieAddedSubscription implements SubscriptionBuilder { 353 | 354 | private static final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor(); 355 | 356 | @Override 357 | public void build (Builder aBuilder) { 358 | aBuilder.field(Fields.field("movieAdded") 359 | .type(Movie.REF) 360 | .dataFetcher((env)->Flux.create ((emitter) -> { 361 | 362 | // use a scheduled executor to simulate an 363 | // event happening on another thread event 364 | // second. 365 | 366 | executor.scheduleAtFixedRate(() -> onMovieAdded(emitter), 1, 1, TimeUnit.SECONDS); 367 | 368 | }))); 369 | } 370 | 371 | private void onMovieAdded (FluxSink aEmitter) { 372 | Map movie = new HashMap<>(); 373 | movie.put("id", UUID.randomUUID().toString().replace("-","")); 374 | movie.put("title", "..."); 375 | aEmitter.next(movie); 376 | } 377 | 378 | } 379 | ``` 380 | 381 | ``` 382 | $ curl -s -X POST -H "Content-Type:application/json" -H "Accept:text/event-stream" -d '{"query":"subscription { movieAdded { id title } }"}' http://localhost:8080/graphql 383 | 384 | data:{"data":{"id":"ef006c125e61435d965bbd9492d00990","title":"..."},"errors":[],"extensions":null} 385 | 386 | data:{"data":{"id":"160ac99f81f740589b6062f5cb70915c","title":"..."},"errors":[],"extensions":null} 387 | 388 | ... and on every second 389 | 390 | ``` 391 | 392 | **Note:** Make sure to use the `Accept:text/event-stream` when subscribing. 393 | 394 | # License 395 | 396 | Version 2.0 of the Apache License. -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Migwn, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 204 | echo $MAVEN_PROJECTBASEDIR 205 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 206 | 207 | # For Cygwin, switch paths to Windows format before running java 208 | if $cygwin; then 209 | [ -n "$M2_HOME" ] && 210 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 211 | [ -n "$JAVA_HOME" ] && 212 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 213 | [ -n "$CLASSPATH" ] && 214 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 215 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 216 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 217 | fi 218 | 219 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 220 | 221 | exec "$JAVACMD" \ 222 | $MAVEN_OPTS \ 223 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 224 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 225 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 226 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 39 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 40 | 41 | @REM set %HOME% to equivalent of $HOME 42 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 43 | 44 | @REM Execute a user defined script before this one 45 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 46 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 47 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 48 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 49 | :skipRcPre 50 | 51 | @setlocal 52 | 53 | set ERROR_CODE=0 54 | 55 | @REM To isolate internal variables from possible post scripts, we use another setlocal 56 | @setlocal 57 | 58 | @REM ==== START VALIDATION ==== 59 | if not "%JAVA_HOME%" == "" goto OkJHome 60 | 61 | echo. 62 | echo Error: JAVA_HOME not found in your environment. >&2 63 | echo Please set the JAVA_HOME variable in your environment to match the >&2 64 | echo location of your Java installation. >&2 65 | echo. 66 | goto error 67 | 68 | :OkJHome 69 | if exist "%JAVA_HOME%\bin\java.exe" goto init 70 | 71 | echo. 72 | echo Error: JAVA_HOME is set to an invalid directory. >&2 73 | echo JAVA_HOME = "%JAVA_HOME%" >&2 74 | echo Please set the JAVA_HOME variable in your environment to match the >&2 75 | echo location of your Java installation. >&2 76 | echo. 77 | goto error 78 | 79 | @REM ==== END VALIDATION ==== 80 | 81 | :init 82 | 83 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 84 | @REM Fallback to current working directory if not found. 85 | 86 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 87 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 88 | 89 | set EXEC_DIR=%CD% 90 | set WDIR=%EXEC_DIR% 91 | :findBaseDir 92 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 93 | cd .. 94 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 95 | set WDIR=%CD% 96 | goto findBaseDir 97 | 98 | :baseDirFound 99 | set MAVEN_PROJECTBASEDIR=%WDIR% 100 | cd "%EXEC_DIR%" 101 | goto endDetectBaseDir 102 | 103 | :baseDirNotFound 104 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 105 | cd "%EXEC_DIR%" 106 | 107 | :endDetectBaseDir 108 | 109 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 110 | 111 | @setlocal EnableExtensions EnableDelayedExpansion 112 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 113 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 114 | 115 | :endReadAdditionalConfig 116 | 117 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 118 | 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 123 | if ERRORLEVEL 1 goto error 124 | goto end 125 | 126 | :error 127 | set ERROR_CODE=1 128 | 129 | :end 130 | @endlocal & set ERROR_CODE=%ERROR_CODE% 131 | 132 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 133 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 134 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 135 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 136 | :skipRcPost 137 | 138 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 139 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 140 | 141 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 142 | 143 | exit /B %ERROR_CODE% 144 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | com.creactiviti 7 | spring-boot-starter-graphql 8 | 0.0.1-SNAPSHOT 9 | jar 10 | 11 | spring-boot-starter-graphql 12 | Spring Boot Starter GraphQL 13 | 14 | 15 | org.springframework.boot 16 | spring-boot-starter-parent 17 | 2.0.0.RC1 18 | 19 | 20 | 21 | 22 | UTF-8 23 | UTF-8 24 | 1.8 25 | 26 | 27 | 28 | 29 | org.springframework.boot 30 | spring-boot-starter-web 31 | 32 | 33 | 34 | org.springframework.boot 35 | spring-boot-starter-webflux 36 | 37 | 38 | 39 | com.graphql-java 40 | graphql-java 41 | 6.0 42 | 43 | 44 | 45 | org.springframework.boot 46 | spring-boot-starter-test 47 | test 48 | 49 | 50 | 51 | io.projectreactor 52 | reactor-test 53 | test 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | org.apache.maven.plugins 62 | maven-compiler-plugin 63 | 2.3.2 64 | 65 | ${java.version} 66 | ${java.version} 67 | 68 | 69 | 70 | maven-assembly-plugin 71 | 2.3 72 | 73 | 74 | jar-with-dependencies 75 | 76 | 77 | 78 | 79 | package 80 | 81 | single 82 | 83 | 84 | 85 | 86 | 87 | org.apache.maven.plugins 88 | maven-source-plugin 89 | 2.1.2 90 | 91 | 92 | attach-sources 93 | 94 | jar 95 | 96 | 97 | 98 | 99 | 100 | org.apache.maven.plugins 101 | maven-javadoc-plugin 102 | 103 | true 104 | true 105 | true 106 | true 107 | true 108 | 109 | 110 | 111 | 112 | attach-javadocs 113 | 114 | jar 115 | 116 | 117 | 118 | 119 | 120 | org.apache.maven.plugins 121 | maven-gpg-plugin 122 | 123 | 124 | sign-artifacts 125 | verify 126 | 127 | sign 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | spring-snapshots 138 | Spring Snapshots 139 | https://repo.spring.io/snapshot 140 | 141 | true 142 | 143 | 144 | 145 | spring-milestones 146 | Spring Milestones 147 | https://repo.spring.io/milestone 148 | 149 | false 150 | 151 | 152 | 153 | maven-snapshots 154 | http://oss.sonatype.org/content/repositories/snapshots 155 | default 156 | 157 | false 158 | 159 | 160 | true 161 | 162 | 163 | 164 | 165 | 166 | 167 | spring-snapshots 168 | Spring Snapshots 169 | https://repo.spring.io/snapshot 170 | 171 | true 172 | 173 | 174 | 175 | spring-milestones 176 | Spring Milestones 177 | https://repo.spring.io/milestone 178 | 179 | false 180 | 181 | 182 | 183 | 184 | 185 | 186 | sonatype-nexus-snapshots 187 | https://oss.sonatype.org/content/repositories/snapshots 188 | 189 | 190 | 191 | 192 | 193 | 194 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/Arguments.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.Scalars; 4 | import graphql.schema.GraphQLArgument; 5 | import graphql.schema.GraphQLNonNull; 6 | 7 | /** 8 | * This class consists exclusively of static methods that operate on or return 9 | * GraphQL field arguments. 10 | * 11 | * @author Arik Cohen 12 | * @since Feb 10, 2018 13 | */ 14 | public final class Arguments { 15 | 16 | private Arguments () {} 17 | 18 | public static GraphQLArgument.Builder stringArgument (String aName) { 19 | return GraphQLArgument.newArgument() 20 | .name(aName) 21 | .type(Scalars.GraphQLString); 22 | } 23 | 24 | public static GraphQLArgument.Builder notNull (GraphQLArgument.Builder aBuilder) { 25 | GraphQLArgument arg = aBuilder.build(); 26 | return GraphQLArgument.newArgument() 27 | .name(arg.getName()) 28 | .defaultValue(arg.getDefaultValue()) 29 | .definition(arg.getDefinition()) 30 | .description(arg.getDescription()) 31 | .type(new GraphQLNonNull(arg.getType())); 32 | } 33 | 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/Fields.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.Scalars; 4 | import graphql.schema.GraphQLFieldDefinition; 5 | import graphql.schema.GraphQLFieldDefinition.Builder; 6 | import graphql.schema.GraphQLNonNull; 7 | 8 | /** 9 | * This class consists exclusively of static methods that operate on or return 10 | * GraphQL fields. 11 | * 12 | * @author Arik Cohen 13 | * @since Feb 10, 2018 14 | */ 15 | public final class Fields { 16 | 17 | private Fields () {} 18 | 19 | public static Builder stringField (String aName) { 20 | return create(aName).type(Scalars.GraphQLString); 21 | } 22 | 23 | public static Builder spelField (String aName, String aExpression) { 24 | return create(aName).dataFetcher(new SpelDataFetcher(aExpression)); 25 | } 26 | 27 | public static Builder notNull (Builder aSource) { 28 | GraphQLFieldDefinition field = aSource.build(); 29 | return create(field.getName()).argument(field.getArguments()) 30 | .type(new GraphQLNonNull(field.getType())) 31 | .dataFetcher(field.getDataFetcher()) 32 | .definition(field.getDefinition()) 33 | .deprecate(field.getDeprecationReason()) 34 | .description(field.getDescription()); 35 | } 36 | 37 | public static Builder field (String aName) { 38 | return create(aName); 39 | } 40 | 41 | private static Builder create (String aName) { 42 | return new Builder().name(aName); 43 | } 44 | 45 | } 46 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/GraphQLAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import java.util.ArrayList; 4 | import java.util.HashSet; 5 | import java.util.List; 6 | import java.util.stream.Collectors; 7 | 8 | import org.springframework.beans.factory.annotation.Autowired; 9 | import org.springframework.context.annotation.Bean; 10 | import org.springframework.context.annotation.ComponentScan; 11 | import org.springframework.context.annotation.Configuration; 12 | 13 | import graphql.GraphQL; 14 | import graphql.schema.GraphQLObjectType; 15 | import graphql.schema.GraphQLObjectType.Builder; 16 | import graphql.schema.GraphQLSchema; 17 | import graphql.schema.GraphQLType; 18 | 19 | /** 20 | * @author Arik Cohen 21 | * @since Feb 07, 2018 22 | */ 23 | @Configuration 24 | @ComponentScan(basePackages="com.creactiviti.spring.boot.starter.graphql") 25 | public class GraphQLAutoConfiguration { 26 | 27 | @Autowired(required=false) 28 | private List queryBuilders = new ArrayList<>(); 29 | 30 | @Autowired(required=false) 31 | private List mutationBuilders = new ArrayList<>(); 32 | 33 | @Autowired(required=false) 34 | private List subscriptionBuilders = new ArrayList<>(); 35 | 36 | @Autowired(required=false) 37 | private List typeBuilders = new ArrayList<>(); 38 | 39 | @Bean 40 | public GraphQL graphql () { 41 | // build the Query (Read) portion of the GraphQL schema 42 | Builder queryBuilder = GraphQLObjectType.newObject().name("Query"); 43 | 44 | queryBuilders.forEach(qb->qb.build(queryBuilder)); 45 | 46 | // build the Mutation (Write) portion of the GraphQL schema 47 | 48 | Builder mutationBuilder = GraphQLObjectType.newObject().name("Mutation"); 49 | 50 | mutationBuilders.forEach(mb->mb.build(mutationBuilder)); 51 | 52 | Builder subscriptionBuilder = GraphQLObjectType.newObject().name("Subscription"); 53 | 54 | subscriptionBuilders.forEach(sb->sb.build(subscriptionBuilder)); 55 | 56 | // build all types 57 | 58 | List types = typeBuilders.stream().map(tb->tb.build()).collect(Collectors.toList()); 59 | 60 | // build the GraphQL schema 61 | 62 | GraphQLSchema.Builder schemaBuilder = GraphQLSchema.newSchema(); 63 | 64 | if(queryBuilders.size() > 0) { 65 | schemaBuilder.query(queryBuilder); 66 | } 67 | 68 | if(mutationBuilders.size() > 0) { 69 | schemaBuilder.mutation(mutationBuilder); 70 | } 71 | 72 | if(subscriptionBuilders.size() > 0) { 73 | schemaBuilder.subscription(subscriptionBuilder); 74 | } 75 | 76 | return GraphQL.newGraphQL(schemaBuilder.additionalTypes(new HashSet<>(types)).build()).build(); 77 | } 78 | 79 | } 80 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/GraphQLController.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import java.util.Map; 4 | 5 | import org.reactivestreams.Publisher; 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.springframework.web.bind.annotation.CrossOrigin; 9 | import org.springframework.web.bind.annotation.PostMapping; 10 | import org.springframework.web.bind.annotation.RequestBody; 11 | import org.springframework.web.bind.annotation.RestController; 12 | 13 | import graphql.ExecutionInput; 14 | import graphql.ExecutionResult; 15 | import graphql.GraphQL; 16 | 17 | /** 18 | * The API endpoint for GraphQL operations. 19 | * 20 | * @author Arik Cohen 21 | * @since Feb 08, 2018 22 | */ 23 | @CrossOrigin 24 | @RestController 25 | public class GraphQLController { 26 | 27 | private final GraphQL graphql; 28 | 29 | private final Logger log = LoggerFactory.getLogger(getClass()); 30 | 31 | public GraphQLController (GraphQL aGraphQL) { 32 | graphql = aGraphQL; 33 | } 34 | 35 | @PostMapping(value="/graphql", consumes="application/json", produces="text/event-stream") 36 | public Publisher reactiveGrapql (@RequestBody Map aQuery) { 37 | return graphql(aQuery).getData(); 38 | } 39 | 40 | @PostMapping(value="/graphql", consumes="application/json", produces="application/json") 41 | public ExecutionResult simpleGraphql (@RequestBody Map aQuery) { 42 | return graphql(aQuery); 43 | } 44 | 45 | private ExecutionResult graphql (@RequestBody Map aQuery) { 46 | long now = System.currentTimeMillis(); 47 | 48 | ExecutionResult result = graphql.execute(ExecutionInput.newExecutionInput() 49 | .query((String)aQuery.get("query")) 50 | .variables((Map) aQuery.get("variables")) 51 | .build()); 52 | 53 | log.debug("{} [{}ms]",aQuery.get("query"),(System.currentTimeMillis()-now)); 54 | 55 | return result; 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/MutationBuilder.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.schema.GraphQLObjectType.Builder; 4 | 5 | /** 6 | * An interface for building the Mutation (Write) portion of a GraphQL schema. 7 | * 8 | * @author Arik Cohen 9 | * @since Feb 08, 2018 10 | */ 11 | public interface MutationBuilder { 12 | 13 | /** 14 | * Invoked on GraphQL Schema creation time so as to contribute to building the Mutation. 15 | * 16 | * @param aBuilder 17 | * The Mutation builder object used for generating the Mutation query. 18 | */ 19 | void build (Builder aBuilder); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/Ping.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import org.springframework.stereotype.Component; 4 | 5 | import graphql.schema.GraphQLObjectType.Builder; 6 | 7 | /** 8 | * @author Arik Cohen 9 | * @since Feb 10, 2018 10 | */ 11 | @Component 12 | public class Ping implements QueryBuilder { 13 | 14 | @Override 15 | public void build (Builder aBuilder) { 16 | aBuilder.field(Fields.stringField("ping").staticValue("OK")); 17 | } 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/QueryBuilder.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.schema.GraphQLObjectType.Builder; 4 | 5 | /** 6 | * An interface for building the Query (Read) portion of a GraphQL schema. 7 | * 8 | * @author Arik Cohen 9 | * @since Feb 08, 2018 10 | */ 11 | public interface QueryBuilder { 12 | 13 | /** 14 | * Invoked on GraphQL Schema creation time so as to contribute to building the Query. 15 | * 16 | * @param aBuilder 17 | * The Query builder object used for generating the query. 18 | */ 19 | void build (Builder aBuilder); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/SpelDataFetcher.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import org.springframework.expression.EvaluationContext; 4 | import org.springframework.expression.Expression; 5 | import org.springframework.expression.ExpressionParser; 6 | import org.springframework.expression.common.TemplateParserContext; 7 | import org.springframework.expression.spel.standard.SpelExpressionParser; 8 | import org.springframework.expression.spel.support.StandardEvaluationContext; 9 | 10 | import graphql.schema.DataFetcher; 11 | import graphql.schema.DataFetchingEnvironment; 12 | 13 | /** 14 | * @author Arik Cohen 15 | * @since Dec 16, 2017 16 | */ 17 | public class SpelDataFetcher implements DataFetcher { 18 | 19 | private static final TemplateParserContext PARSER_CONTEXT = new TemplateParserContext("${", "}"); 20 | private final String expression; 21 | 22 | public SpelDataFetcher (String aExpression) { 23 | expression = aExpression; 24 | } 25 | 26 | @Override 27 | public Object get (DataFetchingEnvironment environment) { 28 | ExpressionParser expressionParser = new SpelExpressionParser(); 29 | Expression parsedExpression = expressionParser.parseExpression(expression, PARSER_CONTEXT); 30 | EvaluationContext context = new StandardEvaluationContext(environment); 31 | return parsedExpression.getValue(context); 32 | } 33 | 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/SubscriptionBuilder.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.schema.GraphQLObjectType.Builder; 4 | 5 | /** 6 | * An interface for building the Subscription type of the GraphQL schema. 7 | * 8 | * @author Arik Cohen 9 | * @since Feb 10, 2018 10 | */ 11 | public interface SubscriptionBuilder { 12 | 13 | /** 14 | * Invoked on GraphQL Schema creation time so as to contribute to building the Subscription type. 15 | * 16 | * @param aBuilder 17 | * The Subscription type builder. 18 | */ 19 | void build (Builder aBuilder); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/TypeBuilder.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.schema.GraphQLType; 4 | 5 | /** 6 | * A interface for building {@link GraphQLType} instances 7 | * that participate in the GraphQL schema. Registered 8 | * implementation will be invoked on schema creation time 9 | * and registered with the GraphQL schema. 10 | * 11 | * @author Arik Cohen 12 | * @since Feb 08, 2018 13 | */ 14 | public interface TypeBuilder { 15 | 16 | /** 17 | * Build a {@link GraphQLType} instance. 18 | * 19 | * @return The created GraphQL type. 20 | */ 21 | GraphQLType build (); 22 | 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/creactiviti/spring/boot/starter/graphql/Types.java: -------------------------------------------------------------------------------- 1 | package com.creactiviti.spring.boot.starter.graphql; 2 | 3 | import graphql.schema.GraphQLInterfaceType; 4 | import graphql.schema.GraphQLList; 5 | import graphql.schema.GraphQLObjectType; 6 | import graphql.schema.GraphQLType; 7 | import graphql.schema.GraphQLTypeReference; 8 | 9 | /** 10 | * This class consists exclusively of static methods that operate on or return 11 | * GraphQL types. 12 | * 13 | * @author Arik Cohen 14 | * @since Feb 10, 2018 15 | */ 16 | public final class Types { 17 | 18 | private Types () {} 19 | 20 | public static GraphQLInterfaceType.Builder interfaceTypeBuilder () { 21 | return new GraphQLInterfaceType.Builder (); 22 | } 23 | 24 | public static GraphQLObjectType.Builder objectTypeBuilder () { 25 | return new GraphQLObjectType.Builder(); 26 | } 27 | 28 | public static GraphQLTypeReference ref (String aName) { 29 | return new GraphQLTypeReference(aName); 30 | } 31 | 32 | public static GraphQLList list (GraphQLType aWrappedType) { 33 | return new GraphQLList(aWrappedType); 34 | } 35 | 36 | } 37 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.creactiviti.spring.boot.starter.graphql.GraphQLAutoConfiguration --------------------------------------------------------------------------------