View Source ExTeal.Resource.Show behaviour (ExTeal v0.28.1)

Defines a behaviour for displaying a resource and the function to execute it.

It relies on (and uses):

When used ExTeal.Resource.Show defines the show/2 action suitable for handling api requests.

To customize the behaviour of the show action the following callbacks can be implemented:

Summary

Returns the model to be represented by this resource.

Returns a Plug.Conn in response to successful show.

Execute the show action on a given module implementing Show behaviour and conn.

@callback handle_show(Plug.Conn.t(), ExTeal.Resource.id()) ::
  Plug.Conn.t() | ExTeal.Resource.record()

Returns the model to be represented by this resource.

Default implementation is the result of the ExTeal.Resource.Record.record/2 callback.

handle_show/2 can return nil to send a 404, a conn with any response/body, or a record to be serialized.

Example custom implementation:

def handle_show(conn, id) do
  Repo.get_by(Post, slug: id)
end

In most cases ExTeal.Resource.Record.record/2 and ExTeal.Resource.Records.records/1 are the better customization hooks.

@callback render_show(ExTeal.Resource.record(), any(), Plug.Conn.t()) :: Plug.Conn.t()

Returns a Plug.Conn in response to successful show.

Default implementation renders the view.

Execute the show action on a given module implementing Show behaviour and conn.