Code Monkey home page Code Monkey logo

graphkt's Introduction

Graphkt

A GraphQL library based on graphql-java with kotlin-friendly builders and ktor routing extensions.

Install

The main way of installing this library is using jitpack.io

repositories {
    // ...
    mavenCentral()
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    // Replace TAG with the desired version
    val graphkt_version = "TAG"
    implementation("org.cufy.graphkt:graphkt-core:$graphkt_version")
    implementation("org.cufy.graphkt:graphkt-ktor:$graphkt_version")
    implementation("org.cufy.graphkt:graphkt-graphql-java:$graphkt_version")
}

How to set up on ktor

The following is an example of using it.

data class Entity(
    val name: String
)

val EntityObjectType: GraphQLObjectType<Entity> = GraphQLObjectType {
    name = "Entity"
    description = "Some entity."

    field(Entity::name) {
        description = "The name of the entity."
        type { GraphQLStringType }
    }

    field("nameWithCustomVar") {
        description = "The name of the entity with the customVar in the context."
        type { GraphQLStringType.Nullable }

        get {
            it.name + context["myCustomVar"]
        }
    }
}

val EntitiesFlow = MutableSharedFlow<Entity>()

fun Application.configureGraphQL() {
    // you can choose any of these IDEs
    // graphiql()
    // apolloSandbox()
    graphqlPlayground() // recommended

    graphql {
        // add import org.cufy.graphkt.java.`graphql-java`
        `graphql-java` {
            // engine-specific configuration
        }

        before {
            context["myCustomVar"] = Math.random()
        }

        schema {
            query {
                description = "The root query."

                field("getEntityWithName") {
                    description = "Get an entity instance."
                    type { EntityObjectType }

                    val nameArg = argument<String>("name") {
                        description = "The name of the entity."
                        type { GraphQLStringType }
                    }

                    get { Entity(nameArg()) }
                }
            }
            mutation {
                description = "The root mutation"

                field("pushEntity") {
                    description = "Push an entity to subscribers"
                    type { EntityObjectType }

                    val nameArg = argument<String>("name") {
                        description = "The name of the entity."
                        type { GraphQLStringType }
                    }

                    get {
                        val entity = Entity(nameArg())
                        EntitiesFlow.emit(entity)
                        entity
                    }
                }
            }
            subscription {
                description = "The root subscription"

                field("subscribeToEntities") {
                    description = "Subscribe to pushed entities"
                    type { EntityObjectType }

                    getFlow { EntitiesFlow }
                }
            }
        }
    }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.