Table of Contents generated with DocToc

Alembic

CircleCI Deps Status Inline docs

A JSONAPI 1.0 library fully-tested against all jsonapi.org examples. The library generates JSONAPI errors documents whenever it encounters a malformed JSONAPI document, so that servers don’t need to worry about JSONAPI format errors. Poison.Encoder implementations ensure the structs can be turned back into JSON strings: struct->encoding->decoding->conversion to struct is tested to ensure idempotency and that the library can parse its own JSONAPI errors documents.

Installation

If available in Hex, the package can be installed as:

  1. Add alembic to your list of dependencies in mix.exs:

    def deps do
      [{:alembic, "~> 1.0.0"}]
    end
  2. Ensure alembic is started before your application:

    def application do
      [applications: [:alembic]]
    end

Contributing

See CONTRIBUTING.md