Documentation

We specialize the RouteDsl type to this as a shorthand.

Convert a RouteDsl into a representation that Yesod can use.

mkYesod App $ toYesod $ do
    get RootR
    "users" // do
       resource UserIndex [get, post]
       -- etc...

GHC freaks out if you try to use a type defined in the same module as the route. Ensure that all types you use in the route are defined in an imported module.

Since: 0.0.1.0

We support the most common HTTP verbs. Each of get, put, post, and delete are given a String that represents the resource they are acting for. The generated route type uses that resource as a constructor. The generated dispatcher expects to see functions with the lowercase verb as a prefix to the resource name. As an example:

get HelloR

Will create a route type HelloR and expect a handler getHelloR to be defined.

Since: 0.0.1.0

We support the most common HTTP verbs. Each of get, put, post, and delete are given a String that represents the resource they are acting for. The generated route type uses that resource as a constructor. The generated dispatcher expects to see functions with the lowercase verb as a prefix to the resource name. As an example:

get HelloR

Will create a route type HelloR and expect a handler getHelloR to be defined.

Since: 0.0.1.0

We support the most common HTTP verbs. Each of get, put, post, and delete are given a String that represents the resource they are acting for. The generated route type uses that resource as a constructor. The generated dispatcher expects to see functions with the lowercase verb as a prefix to the resource name. As an example:

get HelloR

Will create a route type HelloR and expect a handler getHelloR to be defined.

Since: 0.0.1.0

We support the most common HTTP verbs. Each of get, put, post, and delete are given a String that represents the resource they are acting for. The generated route type uses that resource as a constructor. The generated dispatcher expects to see functions with the lowercase verb as a prefix to the resource name. As an example:

get HelloR

Will create a route type HelloR and expect a handler getHelloR to be defined.

Since: 0.0.1.0

Create an endpoint with the given named resource and verb.

Since: 0.0.1.0

Create a subsite with the given name, type, and accessor function name to get the underlying application.

Since: 0.0.1.0

Capture a dynamic path piece and parse it as the provided type. This function is intended to be used with the TypeApplications language extension.

"users" // do
    resource UserIndexR [get, post]
    capture @UserId $ do
        resource UserR [get, put, delete]
        "posts" // do
            resource PostR [get, post]

Since: 0.0.1.0

A version of capture that accepts an explicit Proxy argument. Use this if you don't like the TypeApplications syntax, or have a proxy on hand already.

Since: 0.0.1.0

Define a number of handlers for the named resource. The following code block:

do get HelloR
   put HelloR
   post HelloR
   delete HelloR

is equivalent to this shorter form:

resource HelloR [get, put, post, delete]

Since: 0.0.1.0

Attach a route attribute to every element in the given DSL.

Since: 0.0.1.0

An infix operator alias for attr.

"admin" / "admin" ! do
     resource AdminR [get, put, post]

Since: 0.0.1.0

Provide an inline attribute to the given route.

get HelloR ! "friendly"

An infix operator for pathComponent.

Since: rowdy-0.0.1.0

An infix operator alias for nest.

Since: rowdy-0.0.1.0

An endpoint in the Yesod model.

The type of things that can affect a path.

A value containing a Proxy of some Haskell type.

The HTTP verbs.