Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apartmenttherapy/grapher
Elixir GraphQL Client
https://github.com/apartmenttherapy/grapher
elixir graphql-client
Last synced: 27 days ago
JSON representation
Elixir GraphQL Client
- Host: GitHub
- URL: https://github.com/apartmenttherapy/grapher
- Owner: apartmenttherapy
- License: lgpl-3.0
- Created: 2017-11-27T21:50:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-27T22:09:51.000Z (over 6 years ago)
- Last Synced: 2024-11-15T12:41:08.610Z (about 2 months ago)
- Topics: elixir, graphql-client
- Language: Elixir
- Size: 63.5 KB
- Stars: 7
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grapher
[](https://coveralls.io/github/apartmenttherapy/grapher?branch=master)
Grapher is a GraphQL Client for Elixir. It allows you to manage multiple "schemas" as well as providing for a simple Document storage.
Grapher is probably better suited for use in an application that needs to consume one or more GraphQL APIs than it is for quick discovery/exploration of an API. Although nothing prevents you from using it to run queries from an `iex` session.
## Installation
[Available in Hex](https://hex.pm/packages/grapher), the package can be installed
by adding `grapher` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:grapher, "~> 0.9.0"}
]
end
```
## Usage
There are three main steps to executing a Query or Mutation with Grapher:
1. Registering a Context for the requests
2. Registering one or more Documents to use in requests
3. Executing a Document against a Schema
### Context Registration
Grapher uses what it calls a `SchemaContext` to identify where a Schema lives and any headers that should be used in requests. There is nothing preventing the definition of multiple contexts for the same schema, you just need to give each context a unique name.
```elixir
iex> context = SchemaContext.new("http://www.example.com/graphql", ["Authentication": "bearer 88"])
iex> Grapher.SchemaContext.Store.add_context(:example, context)
:ok
```
Once a Context has been registered it can be retireved and/or updated
```elixir
iex> Grapher.SchemaContext.Store.get(:example)
%SchemaContext{url: "http://www.example.com/graphql", headers: ["Authentication": "bearer 88"]}
iex> new_context = SchemaContext.new("http://axiom.atmedia.xyz/graphql")
iex> Grapher.SchemaContext.Store.update_context(:example, new_context)
:ok
```
### Document Registration
A Document in Grapher is nothing more than the literal query document and a function to be used to translate it to an acceptable payload. Currently the only supported transport layer is HTTP.
```elixir
iex> doc = Document.new("query { allListings { id } }", :query)
%Document{document: "query { allListings { id } }", transport_formatter: &Request.query/2}
```
In order to use a document you currently need to put it into the store first.
```elixir
iex> Grapher.Document.Store.add_document(:listings, doc)
:ok
```
Once you have stored a query you can always update it
```elixir
iex> Grapher.Document.Store.update_document(:listings, doc)
:ok
```
### Document Execution
Once you have one or more contexts and one or more documents you can start executing documents in a given context.
```elixir
iex> Grapher.Executor.run(:listings, :example)
%Grapher.GraphQL.Response{data: %{allListings: [%{id: 8}, %{id: 9}]}, errors: :empty, status_code: 200, transport_error: :empty}
```
If your document allows for variables you can always add them when you run it
```elixir
iex> doc = Document.new("query user($userId: ID!){ user(userId: $userID) { name } }", :query)
iex> Grapher.Document.Store.add_document(:flexible, doc)
iex> Grapher.Executor.run(:flexible, :example, %{userId: "bob"})
%Grapher.GraphQL.Response{data: %{user: %{name: "Bob Jones"}}, errors: :empty, status_code: 200, transport_error: :empty}
```
### Loading Context and Document data at application start
If you want to have your default documents and contexts ready and waiting when your application starts up you just need to add a module to your application which implements the `Grapher.SetupBehaviour` and then set the `:setup_module` config value for `grapher`
```elixir
config :grapher,
setup_module: MySetupModule
```
### Saving/Sharing data between requests
At AT Media our Marketplace API really consists of three services, two of which live behind the main public API. Unfortunately this complicates our logging process. It is not easy to determine which service requests were spawned by a particular public API request. For this reason we have introduced a new Context which is scoped to the life of a process.
To start tracking/sharing data with calls from the current thread simply initialize a `Grapher.Context` struct with the data you wish to share across requests:
```
iex> context = Grapher.Context.new(headers: ["request-id": "38bdkhg348thgdk"])
iex> State.update(context)
:ok
```
Whenever you execute a call with `grapher` it will check for a context belonging to the current process (`pid`) and merge the data in the context with any data provided to the query.
*NOTE*: Each call to `State.update/1` will replace any saved context with the context provided.