relax v0.3.0 → Overview → Relax → Resource → Create

Relax.Resource.Create behaviour

Include in your resource to respond to POST /.

Typically brought into your resource via use Relax.Resource.

Create defines two callback behaviours, one of which (create/2) must be implemented.

In addition this module includes the behaviour Relax.Resource.PermittedParams which is used to whitelist and format jsonapi.org formatted params for use in structs.

Types

createable :: Plug.Conn.t | {atom, any} | module | Ecto.Changeset.t

Callbacks

create/2
(callback) # ↑

Specs:

Create (or attempt to create) a new record.

Receives the conn and the whitelisted and formatted params. See Relax.Resource.PermittedParams for more information on whitelisting params.

This often returns an Ecto.Changeset, which will be saved and formated as is appropriate.

def create(_conn, attributes) do
  Models.Post.changeset(%Models.Post{}, attributes)
end

Alternatively a tuple of either {:ok, model} or {:error, errors} can be returned.

A conn may also be returned:

def create(conn), do: halt send_resp(conn, 401, "nope")
create_resource/1
(callback) # ↑

Specs:

  • create_resource(Plug.Conn.t) :: Plug.Conn.t

This callback can be used to completely override the create action.

It accepts a Plug.Conn and must return a Plug.Conn.t