ApiCommons (ApiCommons v0.1.0) View Source

Functions and Macros for quick REST API endpoint generation.

A full guide to REST API's can be found here

Link to this section Summary

Functions

build(conn, build_fn)

Create a resource

create()

Macro to create an rest api endpoint for resource creation.

delete()

Macro to delete a resource.

index()

Generate an API Endpoint to request a list of ressources.

put()

Macto to update a resource

query()

Query entities returns the result

render(conn, template, params \\ %{})

Call a specific render function for encoded data in conn

resource(conn, ecto_schema, opts)

Use a predefined schema as a resource

show()

Macro to create an rest api endpoint for resource display.

Link to this section Functions

build(conn, build_fn)

Create a resource

create()

(macro)

Macro to create an rest api endpoint for resource creation.

delete()

(macro)

Macro to delete a resource.

index()

(macro)

Generate an API Endpoint to request a list of ressources.

Parameter

schema (Ecto.Schema) The schema to be used for the endpoint generation
params (Map) Parameters to modify the output

put()

(macro)

Macto to update a resource

query()

Query entities returns the result

render(conn, template, params \\ %{})

(macro)

Call a specific render function for encoded data in conn

Parameter

conn: Plug.Conn
template: String describe the template to render
params: The parameter to pass to the render function

resource(conn, ecto_schema, opts)

Use a predefined schema as a resource

show()

(macro)

Macro to create an rest api endpoint for resource display.