Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.

Commit 0dd18fa

Browse files
authored
Update README.md
Tidy up
1 parent bbf2bc0 commit 0dd18fa

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ and join the team!
1919
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2020
**Table of Contents**
2121

22-
- [WARNING: NoClassDefFoundError when using GraphQL Java Tools > 5.4.x](#warning-noclassdeffounderror-when-using-graphql-java-tools--54x)
22+
- [Quick start](#quick-start)
2323
- [Using Gradle](#using-gradle)
2424
- [Using Maven](#using-maven)
2525
- [Documentation](#documentation)
@@ -45,21 +45,15 @@ and join the team!
4545
- [Extended scalars](#extended-scalars)
4646
- [Tracing and Metrics](#tracing-and-metrics)
4747
- [Usage](#usage)
48+
- [FAQs](#faqs)
49+
- [WARNING: NoClassDefFoundError when using GraphQL Java Tools > 5.4.x](#warning-noclassdeffounderror-when-using-graphql-java-tools--54x)
50+
4851
- [Contributions](#contributions)
4952
- [Licenses](#licenses)
5053

5154
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
5255

53-
## WARNING: NoClassDefFoundError when using GraphQL Java Tools > 5.4.x
54-
55-
If you're using `graphql-java-tools` in combination with Spring Boot 2.1.x or below then you need to
56-
set the
57-
`kotlin.version` in your Spring Boot project explicitly to version >= 1.3.70, because Spring Boot
58-
Starter parent of that Spring Boot version overrides it with a 1.2.* version of Kotlin.
59-
`graphql-java-tools` requires 1.3.* however because of its coroutine support. If you don't override
60-
this version you will run into a `NoClassDefFoundError`.
61-
62-
Spring Boot team has indicated the Kotlin version will be upgraded to 1.3 in Spring Boot 2.2.
56+
## Quick start
6357

6458
### Using Gradle
6559

@@ -79,24 +73,24 @@ Set the Kotlin version in your `<properties>` section
7973
</properties>
8074
```
8175

82-
# Documentation
76+
## Documentation
8377

8478
See our new [Documentation](https://www.graphql-java-kickstart.com/spring-boot/).
8579

8680
Repository contains:
8781

8882
* `graphql-spring-boot-starter` to turn your boot application into GraphQL server (
8983
see [graphql-java-servlet](https://github.com/graphql-java-kickstart/graphql-java-servlet))
90-
* `altair-spring-boot-starter`to embed `Altair` tool for schema introspection and query debugging (
84+
* `altair-spring-boot-starter` to embed `Altair` tool for schema introspection and query debugging (
9185
see [altair](https://github.com/imolorhe/altair))
92-
* `graphiql-spring-boot-starter`to embed `GraphiQL` tool for schema introspection and query
86+
* `graphiql-spring-boot-starter` to embed `GraphiQL` tool for schema introspection and query
9387
debugging (see [graphiql](https://github.com/graphql/graphiql))
94-
* `playground-spring-boot-starter`to embed `GraphQL Playground` tool for schema introspection and
88+
* `playground-spring-boot-starter` to embed `GraphQL Playground` tool for schema introspection and
9589
query debugging (see [GraphQL Playground](https://github.com/prisma/graphql-playground))
96-
* `voyager-spring-boot-starter`to embed `Voyager` tool for visually explore GraphQL APIs as an
90+
* `voyager-spring-boot-starter` to embed `Voyager` tool for visually explore GraphQL APIs as an
9791
interactive graph (see [voyger](https://github.com/APIs-guru/graphql-voyager))
9892

99-
# Requirements and Downloads
93+
## Requirements and Downloads
10094

10195
Requirements:
10296

@@ -599,6 +593,22 @@ The following metrics are available for exposure:
599593
* `graphql.websocket.sessions` - number of active websocket sessions for subscriptions
600594
* `graphql.websocket.subscriptions` - number of active subscriptions
601595

596+
597+
## FAQs
598+
### WARNING: NoClassDefFoundError when using GraphQL Java Tools > 5.4.x
599+
600+
If you're using `graphql-java-tools` in combination with Spring Boot 2.1.x or below then you need to
601+
set the
602+
`kotlin.version` in your Spring Boot project explicitly to version >= 1.3.70, because Spring Boot
603+
Starter parent of that Spring Boot version overrides it with a 1.2.* version of Kotlin.
604+
`graphql-java-tools` requires 1.3.* however because of its coroutine support. If you don't override
605+
this version you will run into a `NoClassDefFoundError`.
606+
607+
Spring Boot team has indicated the Kotlin version will be upgraded to 1.3 in Spring Boot 2.2.
608+
609+
610+
611+
602612
# Contributions
603613

604614
Contributions are welcome. Please respect

0 commit comments

Comments
 (0)