Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 6.09 KB

README.md

File metadata and controls

79 lines (47 loc) · 6.09 KB
Raw

GraphQL Kotlin

Continuous Integration Publish Docs Discussions Slack

GraphQL Kotlin is a collection of libraries, built on top of graphql-java, that 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
  • executions - Custom instrumentations for a GraphQL operation
  • generator - Code-First schema generator and extensions to build Apollo Federation schemas
  • plugins - Gradle and Maven plugins
  • servers - Common and library specific modules for running a GraphQL server

⌨️ 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 generating a type-safe client.

Server Example

A basic example of how you can run a GraphQL server can be found on our server documentation section.

Client Example

A basic setup of a GraphQL 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 individual module READMEs, or javadocs, feel free to contribute to the docs or start a discussion 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

If you have a specific question about the library or code, please start a discussion for the community.

We also have a public channel, (#graphql-kotlin), open on the Kotlin Slack instance (kotlinlang.slack.com). 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.

After you have your local branch set up, take a look at our open issues to see where you can contribute.

🛡️ 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