GraphQLRouteCollection

Provides a simple route collection to integrate GraphQLSwift into a Vapor application.

Installation

Add VaporGraphQL to your Package.swift

import PackageDescription

let package = Package(
    dependencies: [
        ...
        .package(url: "https://github.com/stevenlambion/GraphQLRouteCollection.git", .upToNextMajor(from: "0.1.0")),
    ],
    .target(
        name: "App",
        dependencies: [..., "VaporGraphQL"],
    ),
)

Usage

Basic

Create a new HTTPGraphQL service with your schema, then register it:

services.register(HTTPGraphQL() { req in (
  schema: schema,
  rootValue: [:],
  context: req
)})

Then route it in your app's config.swift file:

let router = EngineRouter.default()
let graphQLRouteCollection = GraphQLRouteCollection(enableGraphiQL: true)
try graphQLRouteCollection.boot(router: router)
try routes(router)
services.register(router, as: Router.self)

Introspection

HTTPGraphQL provides a way to introspect the entire graphql schema. This is useful in development when you need to auto-generate a schema for graphql clients.

let graphql = HTTPGraphQL(enableIntrospectionQuery: true) { req in (
    schema: schema,
    rootValue: [:],
    context: [:]
)}

To retrieve the introspected schema simply hit the graphql endpoint without a provided query. It will instead use an internal introspection query.

  fetch("localhost:8080/graphql") { resp in
    let schema = parseSchema(resp.json)
  }

HTTPGraphQL will use the request's method to determine how to retrieve the graphql query. For GET requests, it uses the query items in the URL. For POSTs, it uses the payload.