walmartlabs/ lacinia-pedestal

Clojure

HTML

Shell

HTTP

GraphQL

View on GitHub

Need help with lacinia-pedestal?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

walmartlabs

157 Stars

50 Forks

Other

361 Commits

1 Opened issues

Description

Expose Lacinia GraphQL as Pedestal endpoints

Services available

Need anything else?

Contributors list

Readme

com.walmartlabs/lacinia-pedestal

Name: lacinia-pedestal
Brand: lacinia-pedestal
SKU: //walmartlabs/lacinia-pedestal
Rating: 2.1425 (157 reviews)

A library that adds the Pedestal underpinnings needed when exposing Lacinia as an HTTP endpoint.

Lacinia-Pedestal also supports GraphQL subscriptions, using the same protocol as Apollo GraphQL.

Lacinia-Pedestal Manual | API Documentation

Usage

For a basic Pedestal server, simply supply a compiled Lacinia schema to the

com.walmartlabs.lacinia.pedestal2/default-service

function to generate a service, then invoke

io.pedestal.http/create-server

and

/start

;; This example is based off of the code generated from the template
;;  `lein new pedestal-service graphql-demo`

(ns graphql-demo.server
  (:require [io.pedestal.http :as http]
            [com.walmartlabs.lacinia.pedestal2 :as lp]
            [com.walmartlabs.lacinia.schema :as schema]))
(def hello-schema 
(schema/compile
  {:queries 
    {:hello
      ;; String is quoted here; in EDN the quotation is not required
      {:type 'String
       :resolve (constantly "world")}}}))
;; Use default options:
(def service (lp/default-service hello-schema nil))
;; This is an adapted service map, that can be started and stopped
;; From the REPL you can call server/start and server/stop on this service
(defonce runnable-service (http/create-server service))
(defn -main
  "The entry-point for 'lein run'"
  [& args]
  (println "\nCreating your server...")
  (http/start runnable-service))

Lacinia will handle POST requests at the

/api

endpoint:

$ curl localhost:8888/api -X POST -H "content-type: application/json" -d '{"query": "{ hello }"}'
{"data":{"hello":"world"}}

You can also access the GraphQL IDE at

http://localhost:8888/ide

Development Mode

When developing an application, it is desirable to be able to change the schema without restarting. Lacinia-Pedestal supports this: in the above example, the schema passed to

default-service

could be a function that returns the compiled schema. It could even be a Var containing the function that returns the compiled schema.

In this way, the Pedestal stack continues to run, but each request rebuilds the compiled schema based on the latest code you've loaded into the REPL.

Beyond default-server

default-server

is intentionally limited, and exists only to help you get started. Once you start adding anything more complicated, such as authentication, or supporting multiple schemas (or schema versions) at different paths, you will want to simply create your routes and servers in your own code, using the building-blocks provided by

com.walmartlabs.lacinia.pedestal2

GraphiQL

The GraphiQL packaged inside the library is built using

npm

, from version

0.12.0

License

Distributed under the Apache Software License 2.0.

GraphiQL has its own license.