alexpeachey / json_rpc_toolkit

An Elixir library implementing a transport-agnostic implementation of JSON-RPC 2.0

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JSON-RPC Toolkit

The JSON-RPC Toolkit provides a transport agnostic implementation of the JSON-RPC 2.0 protocol. It also provides optional support for Phoenix HTTP and Web Sockets as those are the most likely transports people will use.

Installation

If available in Hex, the package can be installed by adding json_rpc_toolkit to your list of dependencies in mix.exs:

def deps do
  [
    {:json_rpc_toolkit, "~> 0.9.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/json_rpc_toolkit.

Warning

This library is pre-1.0. One of the primary things missing is a full set of tests to verify it's working condition. It has had some testing by bathing in fire as it is added into a private project, but the actual set of tests in this repo is lacking and it is not recommended the library is used until the tests are in decent shape and the library is bumped to 1.0.0. The other thing missing is documentation and there are unfortunately, no hex docs yet.

About

An Elixir library implementing a transport-agnostic implementation of JSON-RPC 2.0

License:MIT License


Languages

Language:Elixir 100.0%