relax v0.3.0 → Overview → Relax → Responders

Relax.Responders behaviour

Convienience methods for generating JSONAPI.org spec Plug.Conn responses.

Summary

created(conn, model)
invalid(conn, errors)
not_found(conn)
okay(conn, model)
okay(conn, model, meta)
send_error(conn, status, title)
send_json(conn, status, model, module)
send_json(conn, status, model, module, meta)

Functions

not_found(conn)
(function) # ↑
send_error(conn, status, title)
(function) # ↑
send_json(conn, status, model, module)
(function) # ↑
send_json(conn, status, model, module, meta)
(function) # ↑

Macros

created(conn, model)
(macro) # ↑
invalid(conn, errors)
(macro) # ↑
okay(conn, model)
(macro) # ↑
okay(conn, model, meta)
(macro) # ↑

Callbacks

serializer/0
(callback) # ↑

Specs:

  • serializer :: module

Defines the module using JaSerializer that will be used to format successfull responses.