Kitura-GraphQL

Swift GraphQL HTTP Middleware for Kitura

Kitura GraphQL

Swift macOS Linux License Build Status Codebeat

Create a GraphQL HTTP server with Kitura web framework.

Installation

import PackageDescription

let package = Package(
    dependencies: [
        .Package(url: "https://github.com/lgaches/Kitura-GraphQL.git", majorVersion: 0, minor: 0),
    ]
)

Usage

Configuration

GraphQLMiddleware has the following parameters:

  • schema: A Schema instance from Graphiti. A Schema must be provided.
  • showGraphiQL: If true, presentss GraphiQL when the GraphQL endpoint is loaded in a browser. We recommend that you set showGraphiQL to true when your app is in development because it’s quite useful. You may or may not want it in production.
  • rootValue: A value to pass as the rootValue to the schema’s execute function from Graphiti.
  • context: A value to pass as the context to the schema’s execute function from Graphiti. If context is not provided, the RouterRequest struct is passed as the context.

HTTP Usage

Once installed as a middleware at a path, GraphQLMiddleware will accept requests with the parameters:

  • query: A string GraphQL document to be executed.
  • operationName: If the provided query contains multiple named operations, this specifies which operation should be executed. If not provided, a 400 error will be returned if the query contains multiple named operations.
  • variables: The runtime values to use for any GraphQL query variables as a JSON object.
  • raw: If the showGraphiQL option is enabled and the raw parameter is provided raw JSON will always be returned instead of GraphiQL even when loaded from a browser.

Example

import Graphiti
import Kitura
import GraphQLMiddleware

let schema = try Schema<NoRoot, RouterRequest> { schema in
    schema.query = try ObjectType(name: "RootQueryType") { query in
        try query.field(name: "hello", type: String.self) { _ in
            "world"
        }
    }
}


let router = Router()

let graphql = GraphQLMiddleware(schema: schema, showGraphiQL: true, rootValue: noRootValue)


router.all("/graphql", middleware: graphql)

Kitura.addHTTPServer(onPort: 8090, with: router)
Kitura.run()

License

This project is released under the MIT license. See LICENSE for details.

Related Repositories

Kitura-GraphQL

Kitura-GraphQL

Swift GraphQL HTTP Middleware for Kitura ...