Packages

ja_serializer

0.0.1
0.18.2 0.18.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.1 0.14.0 0.13.0 0.12.0 0.11.2 0.11.1 0.11.0 0.10.1 0.10.0 0.9.0 0.8.1 0.8.0 0.7.1 0.7.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.0 0.3.1 0.3.0 0.2.0 0.1.2 0.1.1 0.1.0 0.0.1

A serialization library implementing the jsonapi.org 1.0 spec suitable for use building JSON APIs in Phoenix and any other Plug based framework or app.

HexDocs

Current section

Files

Jump to
Readme
33 Versions
0 Dependencies
Dependants
Files
Activity
ja_serializer README.md
Raw

README.md 

JaSerializer

============



jsonapi.org formatting of Elixir data structures suitable for serialization by

libraries such as Poison.



Warning: This is Alpha software and subject to breaking changes.



## TODO:



* Easy integration into Pheonix.

* Easy integration into Relax.

* Support of all required JSON API 1.0 features.

* Type Specs

* Edgecase/unit tests

* Pagination, meta and advanced links.



## Serializer DSL:



```elixir

defmodule MyApp.ArticleSerializer do

  use JaSerializer



  serialize "articles" do

    location: "/articles/:id"



    attributes [:title, :tags, :body, :excerpt]



    has_one :author,

      include: PersonSerializer,

      field: :authored_by



    has_many :comments,

      link: "/articles/:id/comments",

  end



  def comments(model, _conn) do

    Comment.for_article(model)

  end



  def excerpt(article, _conn) do

    [first | _ ] = String.split(article.body, ".")

    first

  end

end

```



## Usage



```elixir

model

|> MyApp.ArticleSerializer.format(conn)

|> Poison.encode!

```





## License



JaSerializer source code is released under Apache 2 License. Check LICENSE file for more information.