GraphQL

Installation (Gradle)

implementation group: "org.http4k", name: "http4k-graphql", version: "4.34.2.0"

// for the example below you will also need this dependency...
implementation group: "com.expediagroup", name: "graphql-kotlin-schema-generator", version: "5.3.2"

About

This module provides http4k integration for the excellent GraphQL-java library, allowing you to either serve or consume GraphQL services using a simple adapter API.

As with the ethos of http4k, the uniform Server/Client GraphQLHandler model means that you can test applications entirely in-memory without binding to a port. Http4k also ships with a page serving the GraphQL playground which can be added as a simple route.

Code

package guide.reference.graphql

import com.expediagroup.graphql.generator.SchemaGeneratorConfig
import com.expediagroup.graphql.generator.TopLevelObject
import com.expediagroup.graphql.generator.toSchema
import graphql.GraphQL.newGraphQL
import org.http4k.client.JavaHttpClient
import org.http4k.client.asGraphQLHandler
import org.http4k.core.HttpHandler
import org.http4k.core.Uri
import org.http4k.graphql.GraphQLHandler
import org.http4k.graphql.GraphQLRequest
import org.http4k.graphql.GraphQLResponse
import org.http4k.routing.bind
import org.http4k.routing.graphQL
import org.http4k.routing.graphQLPlayground
import org.http4k.routing.routes
import org.http4k.server.SunHttp
import org.http4k.server.asServer

object MyGraphQLHandler : GraphQLHandler {
    private val graphQL = newGraphQL(
        toSchema(
            SchemaGeneratorConfig(supportedPackages = listOf("guide.reference.graphql")),
            listOf(TopLevelObject(UserQueries())),
            listOf()
        )
    ).build()

    override fun invoke(request: GraphQLRequest) =
        GraphQLResponse.from(graphQL.execute(request.query))
}

data class User(val id: Int, val name: String)
data class Params(val ids: List<Int>)

class UserQueries {
    private val userDb = listOf(
        User(id = 1, name = "Jim"),
        User(id = 2, name = "Bob"),
    )

    fun search(params: Params) = userDb.firstOrNull { it.id in params.ids }
}

fun main() {
    val app: HttpHandler = routes(
        "/graphql" bind graphQL(MyGraphQLHandler),
        graphQLPlayground(Uri.of("/graphql"))
    )

    // serve GQL queries/mutations at /graphql
    app.asServer(SunHttp(8000)).start()

    // for clients, just convert any app into a GQL handler
    val gql: GraphQLHandler =
        JavaHttpClient().asGraphQLHandler(Uri.of("http://localhost:8000/graphql"))
    val response: GraphQLResponse = gql(
        GraphQLRequest(
            """{
        search(params: { ids: [1]}) {
            id
            name
        }
    }"""
        )
    )
    println(response)

    println("You can visit the GraphQL playground at: http://localhost:8000")
}