nqv/graphql-kotlin

Libraries for running GraphQL in Kotlin

GraphQL Kotlin

GraphQL Kotlin is a collection of libraries, built on top of graphql-java, that aim to simplify running GraphQL clients and servers in Kotlin.

Visit our documentation site for more details.

📦 Modules

• clients - Lightweight GraphQL Kotlin HTTP clients based on Ktor HTTP client and Spring WebClient
• examples - Example apps that use graphql-kotlin libraries to test and demonstrate usages
• graphql-kotlin-federation - Schema generator extension to build Apollo Federation GraphQL schemas
• graphql-kotlin-schema-generator - Code only GraphQL schema generation for Kotlin
• graphql-kotlin-spring-server - Spring Boot auto-configuration library to create a GraphQL server
• graphql-kotlin-types - Core types used by both client and server
• plugins - Gradle and Maven plugins

⌨️ Usage

While all the individual modules of graphql-kotlin are published as stand-alone libraries, the most common use cases are running a server, and genereating a type-safe client.

Server Example

A basic example of how you can use graphql-kotlin-spring-server to run a GraphQL server can be found on our server documentation section.

Client Example

A basic setup of graphql-kotlin-client can be found on our client documentation section.

📋 Documentation

More examples and documentation are available on our documentation site hosted in GitHub Pages. We also have the examples module which can be run locally for testing and shows example code using the libraries.

If you have a question about something you can not find in our documentation, the indivdual module READMEs, or javadocs, feel free to contribute to the docs or create an issue and tag it with the question label.

If you would like to contribute to our documentation see the website directory for more information.

🗞 Blog Posts and Videos

The Blogs & Videos page in the GraphQL Kotlin documentation links to blog posts, release announcements, conference talks about the library, and general talks about GraphQL at Expedia Group.

👥 Contact

This project is part of Expedia Group Open Source but also maintained by a dedicated team

• Expedia Group OSS

  • https://expediagroup.github.io
  • oss@expediagroup.com

• GraphQL Kotlin Committers

  • Github team: @ExpediaGroup/graphql-kotlin-committers
  • We also have a public channel, (#graphql-kotlin), open on the Kotlin Slack instance. See the info here on how to join this slack instance

✏️ Contributing

To get started, please fork the repo and checkout a new branch. You can then build the library locally with Gradle

./gradlew clean build

See more info in CONTRIBUTING.md

🛡️ Security

For more info on how to contact the team for security issues or the supported versions that receive security updates, see SECURITY.md

⚖️ License

This library is licensed under the Apache License, Version 2.0