0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 12:40:25 +00:00

Update the cowboy_router manual

This commit is contained in:
Loïc Hoguin 2016-12-22 12:53:21 +01:00
parent 89120a3606
commit a1b52494a5
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
6 changed files with 138 additions and 44 deletions

View file

@ -0,0 +1,53 @@
= cowboy_router:compile(3)
== Name
cowboy_router:compile - Compile routes to the resources
== Description
[source,erlang]
----
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
[source,erlang]
----
Dispatch = cowboy_router:compile([
{'_', [
{"/", toppage_h, []},
{"/[...], cowboy_static, {priv_dir, my_example_app, ""}}
]}
]),
{ok, _} = cowboy:start_clear(example, 100, [{port, 8080}], #{
env => #{dispatch => Dispatch}
}).
----
== See also
link:man:cowboy_router(3)[cowboy_router(3)]