multiverse v0.4.3 Multiverse

This is a Plug that allows to manage multiple API versions on request/response gateways.

Examples

pipeline :api do
  ...
  plug Multiverse, gates: [
    "2016-07-31": GateName
  ], version_header: "x-api-version", error_callback: &custom_error_callback/1
end

Summary

Types

opts()

Functions

call(conn, settings)

Callback implementation for Plug.call/2

default_error_callback(, )

Default error callback, that will be used if no error_callback was specified in options

get_latest_version()

Returns string with a current date in format YYYY-MM-DD

init(opts)

Callback implementation for Plug.init/1

Types

opts()

opts() :: [gates: Multiverse.Settings.gates, error_callback: Multiverse.Settings.error_callback, version_header: Multiverse.Settings.version_header]

Functions

call(conn, settings)

call(Conn.t, Multiverse.Settings.t) :: Conn.t

Callback implementation for Plug.call/2.

default_error_callback(, )

Default error callback, that will be used if no error_callback was specified in options.

Returns string with a current date in format YYYY-MM-DD.

get_latest_version()

Returns string with a current date in format YYYY-MM-DD.

init(opts)

init(opts) :: Multiverse.Settings.t

Callback implementation for Plug.init/1.