Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Clone in Desktop Download ZIP
Elixir RESTful Framework
Elixir
Failed to load latest commit information.
lib bugfix: shared params
test add unit test for version extend
.gitignore update .gitignore
.travis.yml Update .travis.yml
CHANGELOG.md bugfix: shared params
LICENSE add LICENSE
README.md update README.md
mix.exs start v0.7.1-dev

README.md

Maru

Elixir copy of grape for creating REST-like APIs.

Build Status Hex.pm Version Hex.pm Downloads

Usage

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

config :maru, MyAPP.API,
  port: 8880

For more information, check out Guides and Examples

TODO

  • rails like url params parser plug#111
  • jsonp support
  • validation, before, before_validation, after, after_validation
Something went wrong with that request. Please try again.