Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: add graphql info #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,21 @@ GraphQL UI for Ring apps:

- [GraphiQL](https://github.com/shahankit/custom-graphiql/) based on [CustomGraphiQL]()
- [GraphQL Voyager](https://github.com/APIs-guru/graphql-voyager)
- [Graphql Playground](https://github.com/prisma-labs/graphql-playground)

## Usage

The `wrap-graphiql` middleware serves the GraphiQL UI and `wrap-voyager` serves the GraphQL Voyager UI.
The `wrap-graphiql` middleware serves the GraphiQL UI, `wrap-voyager` serves the GraphQL Voyager UI and the `wrap-playground` serves the Graphql playground UI .

```clojure
(def app
(-> handler
(wrap-graphiql {:path "/graphiql"
:endpoint "/graphql"})
(wrap-voyager {:path "/voyager"
:endpoint "/graphql"})))
:endpoint "/graphql"})
(wrap-playground {:path "/playground"
:endpoint "/graphql"})))
```

They provides the following options:
Expand All @@ -35,6 +38,10 @@ shahankit/custom-graphiql is licensed under the [MIT License](https://github.com

APIs-guru/graphql-voyager is licensed under the [MIT License](https://github.com/APIs-guru/graphql-voyager/blob/master/LICENSE)

### GraphQL Playground

prisma-labs/graphql-playground is licensed under the [MIT License](https://github.com/prisma-labs/graphql-playground/blob/master/LICENSE)

### Ring-Graphql-UI

Copyright © 2015-2016 Cisco Systems
Expand Down