JSON:API Serializer and Query Handler for Elixir
Elixir

README.md

JSONAPI Elixir

A project that will render your data models into JSONAPI Documents and parse/verify JSONAPI query strings.

Build Status

JSONAPI Support

  • Basic JSONAPI Document encoding [issue
  • Basic support for compound documents
  • Links
  • Relationship links
  • Parsing of sort query parameter into Ecto Query order_by
  • Parsing and limiting of filter keywords.
  • Handling of sparse fieldsets
  • Handling of includes

How to use with Phoenix

Simply add use JSONAPI.View either to the top of your view, or to the web.ex view section and add the proper functions to your view like so.

defmodule MyApp.PostView do
  use JSONAPI.View, type: "posts"

  def fields do
    [:text, :body]
  end

  def relationships do
    # The post's author will be included by default
    [author: {MyApp.UserView, :include},
     comments: MyApp.CommentView]
  end
end

is an example of a basic view. You can now call render(conn, "show.json", MyApp.PostView, %{data: my_data}) or 'list.json normally.

If you'd like to use this without phoenix simply use the JSONAPI.View and call JSONAPI.Serialize(MyApp.PostView, data, conn).

Parsing and validating a JSONAPI Request

plug JSONAPI.QueryParser,
  filter: ~w(name),
  sort: ~w(name title inserted_at),
  view: PostView

This will add a JSONAPI.Config struct called jsonapi_config to your conn.assigns. If a user tries to sort, filter, include, or sparse fieldset an invalid field it will raise a plug error that shows the proper error message.

The config holds the values parsed into things that are easy to pass into an Ecto query, for example

sort=-name will be parsed into sort: [desc: :name] which can be passed directly to the order_by in ecto.

This sort of behavior is consistent for includes. Sparse fieldsets happen in the view using Map.take but when Ecto gets more complex field selection support we will go further to only query the data we need.

You will need to handle filtering yourself, the filter is just a map with key=value.

Other

  • Feel free to make PR's. I will do my best to respond within a day or two.
  • If you want to take one of the TODO items just create an issue or PR and let me know so we avoid duplication.
  • If you need help, I am on irc and twitter.
  • Example project