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

• examples - Example apps that use graphql-kotlin libraries to test and demonstrate usages
• graphql-kotlin-client - Lightweight GraphQL Kotlin HTTP client
• 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 - GraphQL Kotlin Gradle and Maven plugins

Below is a basic example of how you can use graphql-kotlin-spring-server to run a GraphQL server. For more details, see our documentation below or in the individual module READMEs

// Simple data class that is parsed by the schema generator
data class Widget(val id: Int, val value: String)

// Mark the class as a Spring GraphQL Query
@Component
class WidgetService : Query {
  fun widgetById(id: Int): Widget? = null
}

@SpringBootApplication
class Application

fun main(args: Array<String>) {
    runApplication<Application>(*args)
}

will generate a server at /graphql and /playground with the following schema

type Query {
  widgetById(id: Int!): Widget
}

type Widget {
  id: Int!
  value: String!
}

Examples and documentation are available on our documentation site hosted in GitHub Pages.

If you have a question about something you can not find in our documentation, the indivdual module READMEs, or javadocs, feel free to 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.

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

• Expedia Group OSS

  • https://expediagroup.github.io
  • [email protected]

• 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

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

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

This library is licensed under the Apache License, Version 2.0