Packages
maru
0.13.1
0.14.0-pre.1
0.13.2
0.13.1
0.13.0
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.6
0.10.5
0.10.4
0.10.3
0.10.2
0.10.1
0.10.0
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.2
0.7.1
0.7.0
0.6.0
0.5.1
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
REST-like API micro-framework for elixir inspired by grape.
Current section
Files
Jump to
Current section
Files
README.md
# Maru
> REST-like API micro-framework for elixir inspired by [grape](https://github.com/ruby-grape/grape).
[](https://travis-ci.org/elixir-maru/maru)
[](https://hex.pm/packages/maru)
[](https://beta.hexfaktor.org/github/elixir-maru/maru)
[](https://inch-ci.org/github/elixir-maru/maru)
[](https://hex.pm/packages/maru)
## Installation
To get started with Maru, add the following to `mix.exs`:
```elixir
def deps() do
[
{:maru, "~> 0.13"},
# Optional dependency for runtime configuration loading.
{:confex, "~> 3.3"},
]
end
```
[Confex][] allows for runtime configuration to be loaded for ease of environment-specific use.
## Usage
```elixir
defmodule Router.User do
use Maru.Router
namespace :user do
route_param :id do
get do
json(conn, %{ user: params[:id] })
end
desc "description"
params do
requires :age, type: Integer, values: 18..65
requires :gender, type: Atom, values: [:male, :female], default: :female
group :name, type: Map do
requires :first_name
requires :last_name
end
optional :intro, type: String, regexp: ~r/^[a-z]+$/
optional :avatar, type: File
optional :avatar_url, type: String
exactly_one_of [:avatar, :avatar_url]
end
post do
...
end
end
end
end
defmodule Router.Homepage do
use Maru.Router
resources do
get do
json(conn, %{ hello: :world })
end
mount Router.User
end
end
defmodule MyAPP.API do
use Maru.Router
before do
plug Plug.Logger
plug Plug.Static, at: "/static", from: "/my/static/path/"
end
plug Plug.Parsers,
pass: ["*/*"],
json_decoder: Jason,
parsers: [:urlencoded, :json, :multipart]
mount Router.Homepage
rescue_from Unauthorized, as: e do
IO.inspect e
conn
|> put_status(401)
|> text("Unauthorized")
end
rescue_from [MatchError, RuntimeError], with: :custom_error
rescue_from :all, as: e do
conn
|> put_status(Plug.Exception.status(e))
|> text("Server Error")
end
defp custom_error(conn, exception) do
conn
|> put_status(500)
|> text(exception.message)
end
end
```
Then configure `maru`:
```elixir
# config/config.exs
config :maru, MyAPP.API,
http: [port: 8880]
# config/test.exs
config :maru, MyAPP.API,
test: true
```
For more information, check out [Guides](https://maru.readme.io) and [Examples](https://github.com/elixir-maru/maru_examples)
[confex]: https://hex.pm/packages/confex