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

Compile routes and start a listener
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)

Cowboy 2.5 Function Reference

Navigation

Version select

Like my work? Donate!

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.