Maru v0.12.0 Maru.Builder.DSLs View Source

General DSLs for parsing router.

Link to this section Summary

Functions

Define plugs which execute before routes match

Define description for current endpoint

Define description with a block for current endpoint

Mount another router to current router

Define params block of current endpoint

Save shared param to module attribute

Define pipeline block of current endpoint

Push a Plug struct to current scope

Push a Plug struct with options and guards to current scope

Push a overridable Plug struct to current scope

Push a overridable Plug struct with options and guards to current scope

Define path prefix of current router

Define version of current router

version: “v1”, do … end: Version of routes within block

Link to this section Functions

Define plugs which execute before routes match.

Define description for current endpoint.

Link to this macro desc(desc, list) View Source (macro)

Define description with a block for current endpoint.

Mount another router to current router.

Define params block of current endpoint.

Link to this macro params(name, list) View Source (macro)

Save shared param to module attribute.

Link to this macro pipeline(block) View Source (macro)

Define pipeline block of current endpoint.

Push a Plug struct to current scope.

Link to this macro plug(plug, opts) View Source (macro)

Push a Plug struct with options and guards to current scope.

Link to this macro plug_overridable(name, plug) View Source (macro)

Push a overridable Plug struct to current scope.

Link to this macro plug_overridable(name, plug, opts) View Source (macro)

Push a overridable Plug struct with options and guards to current scope.

Define path prefix of current router.

Define version of current router.

Link to this macro version(v, opts) View Source (macro)

version: “v1”, do … end: Version of routes within block.

version: “v2”, extend: “v1”, at: V1 Define version and extended router of current router.