/maru

Elixir RESTful Framework

Primary LanguageElixirBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Maru

Elixir copy of grape for creating REST-like APIs.

Build Status hex.pm Version

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

  def error(conn, _e) do
    status 500

    "Server Error"
  end
end

then add the maru to your config/config.exs

config :maru, MyAPP.API,
  port: 8880

For more info, you can move to Getting Started Guide, Router Guide and Examples

TODO

  • params macro
  • mutually_exclusive exactly_one_of at_least_one_of macro for params
  • group macro for params
  • header macro
  • assign macro
  • helper macro
  • generate docs
  • custom params validators
  • version support
  • https support
  • generate detail docs include params
  • swagger support #1
  • rails like url params parser plug#111
  • params unused warning
  • complex path for namespaces
  • prefix macro
  • work with phoenix guide
  • HTTP Status Code
  • reusable params
  • redirecting
  • error!
  • jsonp support
  • validation, before, before_validation, after, after_validation