Packages
maru
0.4.0
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
> Elixir copy of [grape](http://intridea.github.io/grape/) for creating REST-like APIs.
[](https://travis-ci.org/falood/maru)
[](https://hex.pm/packages/maru)
[](https://hex.pm/packages/maru)
## Usage
```elixir
defmodule Router.User do
use Maru.Router
namespace :user do
route_param :id do
get do
%{ user: params[:id] }
end
desc "description"
params do
requires :age, type: Integer, values: 18..65
requires :sex, 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
%{ hello: :world }
end
mount Router.User
end
end
defmodule MyAPP.API do
use Maru.Router
plug Plug.Static, at: "/static", from: "/my/static/path/"
mount Router.Homepage
rescue_from Unauthorized, as: e do
IO.inspect e
status 401
"Unauthorized"
end
rescue_from :all do
status 500
"Server Error"
end
end
```
then add the `maru` to your `config/config.exs`
```elixir
config :maru, MyAPP.API,
port: 8880
```
For more info, you can move to [Getting Started Guide](https://github.com/falood/maru/blob/master/guide/getting_started.md), [Router Guide](https://github.com/falood/maru/blob/master/guide/router.md) and [Examples](https://github.com/falood/maru_examples)
## TODO
- [ ] rails like url params parser [plug#111](https://github.com/elixir-lang/plug/issues/111)
- [ ] complex path for namespaces
- [ ] work with phoenix guide
- [ ] jsonp support
- [ ] validation, before, before\_validation, after, after\_validation