WebGear.Middlewares.Path

Middlewares related to route paths.

Documentation

path :: forall s ts res m a. (KnownSymbol s, MonadRouter m) => RequestMiddleware m ts (Path s ': ts) res a

A middleware that literally matches path s.

The symbol s could contain one or more parts separated by a forward slash character. The route will be rejected if there is no match.

For example, the following code could be used to match the URL path "a/b/c" and then invoke handler:

path @"a/b/c" handler

pathVar :: forall tag val ts res m a. (FromHttpApiData val, MonadRouter m) => RequestMiddleware m ts (PathVar tag val ': ts) res a

A middleware that captures a path variable from a single path component.

The value captured is converted to a value of type val via FromHttpApiData. The route will be rejected if the value is not found or cannot be converted.

For example, the following code could be used to read a path component as Int tagged with the symbol "objId", and then invoke handler:

pathVar @"objId" @Int handler

match :: QuasiQuoter

Produces middleware(s) to match an optional HTTP method and path.

This quasiquoter can be used in several ways:

• [match|a/b/c] is equivalent to path @"a/b/c"
• [match|a/b/objId:Int/d] is equivalent to path @"a/b" . pathVar @"objId" @Int . path "d"@
• [match|GET a/b/c] is equivalent to method @GET $ path @"a/b/c"
• [match|GET a/b/objId:Int/d] is equivalent to method @GET . path @"a/b" . pathVar @"objId" @Int . path @"d"