A DSL to supplement Plug Router with a resource-oriented routing algorithm.

It provides a macro to generate routes that dispatch to specific resource handlers. For example:

defmodule MyApp.Router do
  use PlugRest.Router

  plug :match
  plug :dispatch

  resource "/pages/:page", PageResource
end

The resource/4 macro accepts a request of format "/pages/VALUE" and dispatches it to PageResource, which must be a Plug module.

See PlugRest.Resource for information on how to write a Plug module that implements REST semantics.

From Plug.Router:

Notice the router contains a plug pipeline and by default it requires two plugs: match and dispatch. match is responsible for finding a matching route which is then forwarded to dispatch. This means users can easily hook into the router mechanism and add behaviour before match, before dispatch or after both.

Routes

resource "/hello", HelloResource

The example above will route any requests for "/hello" to the HelloResource module.

A route can also specify parameters which will be available to the resource:

resource "/hello/:name", HelloResource

The value of the dynamic path segment can be read inside the HelloResource module:

%{"name" => name} = conn.params

Routes allow globbing, which will match the end of the route. The glob can be discarded:

# matches all routes starting with /hello
resource "/hello/*_rest", HelloResource

Or saved as a param for the resource to read:

# matches all routes starting with /hello and saves the rest
resource "/hello/*rest", HelloResource

If we make a request to "/hello/value" then conn.params will include:

%{"rest" => ["value"]}

A request to "/hello/value/extra" will populate conn.params with:

%{"rest" => ["value", "extra"]}