Getting started
Galak is an implementation-first GraphQL execution library.
Galak:
- Generates a GraphQL schema from your Kotlin code: write Kotlin, get a typesafe API.
- Doesn’t use reflection. Use it on the JVM and enjoy ultra-fast start times. Or use it with Kotlin native. Galak is KMP-ready!
- Supports custom scalars, subscriptions, persisted queries and everything in the current GraphQL draft.
- Integrates with Ktor, http4k and Spring.
- Supports Apollo Federation.
Under the hood, Galak uses KSP to generate GraphQL resolvers and types from your Kotlin code.
Gradle configuration
Galak comes with a Gradle plugin that:
- Configures KSP:
- Adds
galak-processorto the KSP configuration. - Configure
service&packageNameKSP arguments.
- Adds
- Configures dependency resolution to align Galak versions if none is specified.
- Adds
galakCheckSchemaandgalakDumpSchematasks (see Monitoring the generated schema)
Configure your Gradle build:
plugins { // Kotlin and KSP are required id("org.jetbrains.kotlin.jvm").version(kotlinVersion) id("com.google.devtools.ksp").version(kspVersion) // Add the Galak plugin id("net.mbonnin.galak").version("0.0.0")}
dependencies { // Add the runtime dependency implementation("net.mbonnin.galak:galak-runtime")}
// Configure codegengalak { service("service") { packageName = "com.example" }}Disable KSP for tests (doc):
ksp.allow.all.target.configuration=falseDefine your root query
Write your root query class in a Query.kt file:
// @GraphQLQuery is the entry point for KSP processing@GraphQLQueryclass Query { // Public functions become GraphQL fields // Kdoc comments become GraphQL descriptions // Kotlin parameters become GraphQL arguments /** * Greeting for name */ fun hello(name: String): String { return "Hello $name" }}Run the codegen:
./gradlew kspKotlin# or if multiplatform./gradlew kspCommonMainKotlinMetadataExecute your query
The codegen generates a com.example.ServiceExecutableSchemaBuilder class that is the entry point to execute GraphQL requests:
val executableSchema = ServiceExecutableSchemaBuilder() .build()Create a GraphQL request:
val request = GraphQLRequest.Builder() .document("{ hello(name: \"sample\") }") .build()Execute the GraphQL request:
val response = executableSchema.execute( request, ExecutionContext.Empty)
println(response.data)// {hello=Hello sample}Galak supports objects, interfaces, unions, enum, input objects, deprecation, customizing names and descriptions and more.
See the Generating a schema page for more details.
Integrate with your favorite server library
Galak comes with integrations for popular server libraries:
See the respective documentation for how to configure a server with an ExecutableSchema.