A GraphQL client for Elixir.
Index
Installation
def deps do
[{:neuron, "~> 3.0.0"}]
end
JSON library
Neuron defaults to using Jason for JSON encoding and decoding. To use Jason, add it to your deps
{:jason, "~> 1.1"}
It is also possible to customize which JSON library that is used
Neuron.Config.set(json_library: AnotherJSONLibrary)
Usage
iex> Neuron.Config.set(url: "https://example.com/graph")
iex> Neuron.query("""
{
films {
count
}
}
""")
# Response will be:
{:ok, %Neuron.Response{body: %{"data" => {"films" => { "count": 123 }}}%, status_code: 200, headers: []}}
# You can also run mutations
iex> Neuron.query("""
mutation createUser($name: String!) {
createUser(name: $name) {
id
name
}
}
""",
%{name: "uesteibar"}
)
# You can also set url and headers as shown below
iex> Neuron.query("""
mutation createUser($name: String!) {
createUser(name: $name) {
id
name
}
}
""",
%{name: "uesteibar"},
url: "https://example.com/graph",
headers: [authorization: "Bearer <token>"]
)
More extensive documentation can be found at https://hexdocs.pm/neuron.
Running locally
Clone the repository
git clone git@github.com:uesteibar/neuron.git
Install dependencies
cd neuron
mix deps.get
To run the tests
mix test
To run the lint
mix credo
Contributing
Pull requests are always welcome =)
The project uses standard-changelog to update the Changelog with each commit message and upgrade the package version.
For that reason every contribution should have a title and body that follows the conventional commits standard conventions (e.g. feat(connection): Make it smarter than Jarvis).
To make this process easier, you can do the following:
Install commitizen and cz-conventional-changelog globally
npm i -g commitizen cz-conventional-changelog
Save cz-conventional-changelog as default
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
Instead of git commit, you can now run
git cz
and follow the instructions to generate the commit message.