PhoenixRest
Resource routing and REST behaviour for Phoenix web applications.
PhoenixRest integrates the
PlugRest library into
your Phoenix application by making a new resource
macro available in
the existing router.
Hello World
Add a new route to your router to match a path with a resource handler:
defmodule HelloPhoenix.Router do
use HelloPhoenix.Web, :router
resource "/hello", HelloPhoenix.HelloResource
end
Create a resource at web/resources/hello_resource.ex
defining the
resource handler, and implement the optional callbacks:
defmodule HelloPhoenix.HelloResource do
use PlugRest.Resource
def to_html(conn, state) do
{"Hello world", conn, state}
end
end
Installation
Add PhoenixRest to your Phoenix project in three steps:
Add
:phoenix_rest
to your list of dependencies inmix.exs
:def deps do [{:phoenix_rest, "~> 0.1.0"}] end ```
Ensure
phoenix_rest
is started before your application:def application do [applications: [:phoenix_rest]] end ```
Edit
web/web.ex
and add the router:def router do quote do use Phoenix.Router use PhoenixRest.Router end end ```