Maru v0.11.4 API Reference

Modules

This is documentation for maru

Generate functions

DSLs for defining top-level plugs

General DSLs for parsing router

Parse and build description block

Generate endpoints of maru router

Handle exceptions of current router

Method DSLs for parsing router

Namespace DSLs for parsing router

Parse and build param_content block

General DSLs for parsing router

Generate routes of maru router

Base versioning adapter with default functions

Adapter for accept-header versioning module

Adapter for no versioning module

Adapter for parameter versioning module

Adapter for path versioning module

Adapter for generating test functions

Define helper for maru router

This module is a wrapper for request and response of maru

Middleware of maru is a standalone plug with Maru.Response helper

Bring maru’s params parser to Phoenix, just use it as the same as maru. Look at maru’s documents for more details

This module is a plug, fetch version from connection and wirte to private variable maru_version

This module is a plug, match all path and raise Maru.Exceptions.NotFound

This module is a plug, put version to private variable maru_version

This module is a plug, save current conn to process dict

Unittest wrapper for designated router

Buildin Type: Atom

Buildin Type: Base64

Buildin Type: Boolean

Buildin Type: CharList

Buildin Type: File

Buildin Type: Float

Buildin Type: Integer

Buildin Type: Json

Buildin Type: List

Buildin Type: Map

Buildin Type: Type

Param Validator: check whether black value is illegal

Param Validator: make sure at least one of designated params present

Param Validator: make sure only one of designated params present

Param Validator: raise when exclusive params present at the same time

Param Validator: check whether param and regexp matched

Param Validator: check whether param in list or range

Print routes for a Maru.Router module

Exceptions

Raised when get param from request

Raised when request path matched but method not matched. Catch this exception and return 405 like this

Raised when request path don’t match any router. Catch this exception and return 404 like this

Raised when type not found

Raised when validater not found

Raised when validate param failed