ApiCommons.Request (ApiCommons v0.1.0) View Source

Describe REST API request information in Plug.Conn.
Use private field "private" of Plug.Conn.

https://hexdocs.pm/plug/Plug.Conn.html

Link to this section Summary

Types

separated()

t()

Functions

body_params(conn)

call(conn, opts)

Put initial values into Plug.Conn for further processing.

endpoint(conn)

errors(conn)

A map of errors that occured during processing of received parameter.

fetch(conn)

Fetch library information from Plug.Conn.

fetch_params(conn)

Merge parameters from Plug.Conn and parameters received at endpoint.
Puts the merged parameter into a map.

## Parameter
    - conn (Plug.Conn) 
    - params (Map)

## Returns
    - Map containing all parameters %{path: [], query: [], body: []}

## Examples

filter(conn)

Fetch filter information available.

get(request, key)

Access parsed data stored in the request struct.

get(conn, key, default \\ nil)

header(conn, header_key)

init(opts)

method(conn)

new(params)

Create a new request struct from parameters Returns: %Request{}

pagination(conn)

Parsed pagination information

path_params(conn)

put_schema()

Put schema for parameter valdation in Plug.Conn

query_params(conn)

separate(conn)

Remove library information from Plug.Conn.

update(parameter, conn)

Add base library information Plug.Conn.

valid?(conn)

Is the current request still valid?

Link to this section Types

separated()

Specs

separated() :: {map(), Plug.Conn.t()}

t()

Specs

t() :: %ApiCommons.Request{
  __meta__: map(),
  errors: map(),
  parsed: map(),
  valid?: boolean()
}

Link to this section Functions

body_params(conn)

call(conn, opts)

Put initial values into Plug.Conn for further processing.

endpoint(conn)

errors(conn)

A map of errors that occured during processing of received parameter.

Returns: Map

fetch(conn)

Fetch library information from Plug.Conn.

Returns: {Map, Plug.Conn}

fetch_params(conn)

Merge parameters from Plug.Conn and parameters received at endpoint.
Puts the merged parameter into a map.

## Parameter
    - conn (Plug.Conn) 
    - params (Map)

## Returns
    - Map containing all parameters %{path: [], query: [], body: []}

## Examples

filter(conn)

Fetch filter information available.

Returns: Map

get(request, key)

Access parsed data stored in the request struct.

Parameter

get(conn, key, default \\ nil)

init(opts)

method(conn)

new(params)

Create a new request struct from parameters Returns: %Request{}

pagination(conn)

Parsed pagination information

Returns: Map

path_params(conn)

put_schema()

Put schema for parameter valdation in Plug.Conn

query_params(conn)

separate(conn)

Specs

separate(Plug.Conn.t()) :: tuple()

Remove library information from Plug.Conn.

update(parameter, conn)

Add base library information Plug.Conn.

Returns: Plug.Conn

valid?(conn)

Is the current request still valid?

Returns: boolean