clj-simple-router.core
make-matcherclj
(make-matcher routes)Given set of routes, builds matcher structure. See router
Given set of routes, builds matcher structure. See `router`
matchclj
(match matcher path)Given matcher (see make-matcher) and a path, returns a vector of match and path params.
If nothing is found, returns nil.
(let [matcher (make-matcher {"GET /a//b/" :key})] (match matcher "/a/1/b/2")) ;; => [:key ["1" "2"]]
Given matcher (see `make-matcher`) and a path, returns a vector of match and path params.
If nothing is found, returns nil.
(let [matcher (make-matcher {"GET /a/*/b/*" :key})]
(match matcher "/a/1/b/2"))
;; => [:key ["1" "2"]]routerclj
(router routes)Given set of routes, returns ring handler. Routes are map from strings to handlers:
{<route> (fn [req] {:status 200, ...})}, ...}
Some route examples:
"GET /" ;; will match / only "GET /login" ;; will match /login "GET /article/" ;; will match /article/1, /article/xxx, but not /article or /article/1/update "GET /article//" ;; will match e.g. /article/1/update "GET /article/**" ;; will match both /article, /article/1 and /article/1/update and deeper "POST /login" ;; will match POST /login "GET /article//update" ;; single stars can be in the middle of path, but double stars can’t "* /article" ;; method can be wildcard, too "GET /" ;; will match anything GET "* /" ;; will match anything
Routes are order-independent and sorted automatically by specificity. This allows overlapping:
GET /article/* GET /article/new
can both co-exist, and /article/new will always be checked first before falling back into /article/*.
Any explicit path segment has higher specificity than a star, so this:
GET /article
will always be matched before this (one path segment of any):
GET /*
Single star, in turn, has higher specificity than double star, so this (any number of segments, 0-∞) will always match last:
GET /**
Values captured by * and ** will be passed down as :path-params vector:
{"GET /a//b/" (fn [req] (let [[p p2] (:path-params req)] ;; e.g. ["1" "2"] if uri was /a/1/b/2 ...))
"GET /media/**" (fn [req] (let [path (:path-params req)] ;; [] for /media ;; ["abc"] for /media/abc ;; ["x/y/z"] for /media/x/y/z ...))}
"* /article/*" (fn [req] (let [[method id] (:path-params req)] ;; ["GET" "1"] for GET /article/1 ...))}
Given set of routes, returns ring handler. Routes are map from strings to handlers:
{<route> (fn [req] {:status 200, ...})}, ...}
Some route examples:
"GET /" ;; will match / only
"GET /login" ;; will match /login
"GET /article/*" ;; will match /article/1, /article/xxx, but not /article or /article/1/update
"GET /article/*/*" ;; will match e.g. /article/1/update
"GET /article/**" ;; will match both /article, /article/1 and /article/1/update and deeper
"POST /login" ;; will match POST /login
"GET /article/*/update" ;; single stars can be in the middle of path, but double stars can’t
"* /article" ;; method can be wildcard, too
"GET /**" ;; will match anything GET
"* /**" ;; will match anything
Routes are order-independent and sorted automatically by specificity. This allows overlapping:
GET /article/*
GET /article/new
can both co-exist, and /article/new will always be checked first before falling back into /article/*.
Any explicit path segment has higher specificity than a star, so this:
GET /article
will always be matched before this (one path segment of any):
GET /*
Single star, in turn, has higher specificity than double star,
so this (any number of segments, 0-∞) will always match last:
GET /**
Values captured by * and ** will be passed down as :path-params vector:
{"GET /a/*/b/*"
(fn [req]
(let [[p p2] (:path-params req)] ;; e.g. ["1" "2"] if uri was /a/1/b/2
...))
"GET /media/**"
(fn [req]
(let [path (:path-params req)] ;; [] for /media
;; ["abc"] for /media/abc
;; ["x/y/z"] for /media/x/y/z
...))}
"* /article/*"
(fn [req]
(let [[method id] (:path-params req)] ;; ["GET" "1"] for GET /article/1
...))}
routescljmacro
(routes & body)A convenience macro that helps you define routes.
body :: (<path-template> <path-params-vector> <handler-body>)+
By default, <path-params-vector> will be bound to (:path-params req). If <path-params-vector> is not a vector, it’ll be bound to req instead.
Returns routes map, suitable to be passed to router or wrap-routes.
Example:
(routes "GET /post//xxx/" [a b] {:status 200, :body (str a b)}
"* /**" req
(let [[method path] (:path-params req)]
...))
A convenience macro that helps you define routes.
body :: (<path-template> <path-params-vector> <handler-body>)+
By default, `<path-params-vector>` will be bound to `(:path-params req)`. If `<path-params-vector>` is not a vector, it’ll be bound to `req` instead.
Returns routes map, suitable to be passed to `router` or `wrap-routes`.
Example:
(routes
"GET /post/*/xxx/*" [a b]
{:status 200, :body (str a b)}
"* /**" req
(let [[method path] (:path-params req)]
...))
wrap-routesclj
(wrap-routes handler routes)Wraps existing handler, and if no route matched, will pass control to it
Wraps existing handler, and if no route matched, will pass control to it
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close