README.md in rack-graphql-0.3.0 vs README.md in rack-graphql-0.4.0
- old
+ new
@@ -3,11 +3,11 @@
# rack-graphql
`rack-graphql` is designed to build ruby services with graphql api. It provides `/graphql` endpoint and can handle [subscriptions](https://graphql-ruby.org/guides#subscriptions-guides) and [multiplex](https://graphql-ruby.org/queries/multiplex.html).
-It works on pure rack and none of `ActionController`/`ActionDispatch`/`ActionPack` or `Sinatra` is required.
+It works on pure rack and none of `ActionController`/`ActionDispatch`/`ActionPack` or `Sinatra` is required. By default it provides health route on `/health` and `/`, which can be disabled.
It can be used together with rails to not make graphql requests be routed with `ActionDispatch` or more pure ruby apps.
## Installation
@@ -21,11 +21,13 @@
Add following to your `config.ru` file:
```ruby
run RackGraphql::Application.call(
- schema: YourGraqphqlSchema, # required
- context_handler: YourGraphqlContextHandler # optional, empty `proc` by default
+ schema: YourGraqphqlSchema, # required
+ app_name: 'your-service-name', # optional, used for health endpoint content
+ context_handler: YourGraphqlContextHandler, # optional, empty `proc` by default
+ health_route: true, # optional, true by default
)
```
`context_handler` can be a class, object or proc. It must respond to `call` method taking `env` as an argument. It is supposed to decode or transform request properties to graphql context (eg. jwt token to user object, as shown on an example below).