cowboy_router:compile(3)

Name

cowboy_router:compile - Compile routes to the resources

Description

compile(cowboy_router:routes()) -> cowboy_router:dispatch_rules()

Compile routes to the resources.

Takes a human readable list of routes and transforms it into a form more efficient to process.

Arguments

Routes

Human readable list of routes.

Return value

An opaque dispatch rules value is returned. This value must be given to Cowboy as a middleware environment value.

Changelog

• 1.0: Function introduced.

Examples

Dispatch = cowboy_router:compile([
    {'_', [
        {"/", toppage_h, []},
        {"/[...]", cowboy_static, {priv_dir, my_example_app, ""}}
    ]}
]),

{ok, _} = cowboy:start_clear(example, [{port, 8080}], #{
    env => #{dispatch => Dispatch}
}).

See also

cowboy_router(3)