mirror of
https://github.com/metosin/reitit.git
synced 2025-12-17 00:11:11 +00:00
Update README
This commit is contained in:
parent
0de9e1b3c6
commit
406b4c653f
2 changed files with 55 additions and 5 deletions
59
README.md
59
README.md
|
|
@ -179,7 +179,7 @@ Path-based routing:
|
||||||
|
|
||||||
On match, route meta-data is returned and can interpreted by the application.
|
On match, route meta-data is returned and can interpreted by the application.
|
||||||
|
|
||||||
Routers also support meta-data compilation enabling things like fast [Ring](https://github.com/ring-clojure/ring) or [Pedestal](http://pedestal.io/) -style handlers. Compilation results are found under `:handler` in the match. See [configuring routers](configuring-routers) for details.
|
Routers also support meta-data compilation enabling things like fast [Ring](https://github.com/ring-clojure/ring) or [Pedestal](http://pedestal.io/) -style handlers. Compilation results are found under `:handler` in the match. See [configuring routers](#configuring-routers) for details.
|
||||||
|
|
||||||
## Ring
|
## Ring
|
||||||
|
|
||||||
|
|
@ -281,6 +281,59 @@ Nested middleware works too:
|
||||||
|
|
||||||
Ring-router supports also 3-arity [Async Ring](https://www.booleanknot.com/blog/2016/07/15/asynchronous-ring.html), so it can be used on [Node.js](https://nodejs.org/en/) too.
|
Ring-router supports also 3-arity [Async Ring](https://www.booleanknot.com/blog/2016/07/15/asynchronous-ring.html), so it can be used on [Node.js](https://nodejs.org/en/) too.
|
||||||
|
|
||||||
|
### Meta-data based extensions
|
||||||
|
|
||||||
|
The routing `Match` is injected into a request and can be extracted with `reitit.ring/get-match` helper. It can be used to build dynamic extensions to the system.
|
||||||
|
|
||||||
|
A middleware to guard routes:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(require '[clojure.set :as set])
|
||||||
|
|
||||||
|
(defn wrap-enforce-roles [handler]
|
||||||
|
(fn [{:keys [::roles] :as request}]
|
||||||
|
(let [required (some-> request (ring/get-match) :meta ::roles)]
|
||||||
|
(if (and (seq required) (not (set/intersection required roles)))
|
||||||
|
{:status 403, :body "forbidden"}
|
||||||
|
(handler request)))))
|
||||||
|
```
|
||||||
|
|
||||||
|
Mounted to an app via router meta-data (effecting all routes):
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(def handler (constantly {:status 200, :body "ok"}))
|
||||||
|
|
||||||
|
(def app
|
||||||
|
(ring/ring-handler
|
||||||
|
(ring/router
|
||||||
|
[["/api"
|
||||||
|
["/ping" handler]
|
||||||
|
["/admin" {::roles #{:admin}}
|
||||||
|
["/ping" handler]]]]
|
||||||
|
{:meta {:middleware [wrap-enforce-roles]}})))
|
||||||
|
```
|
||||||
|
|
||||||
|
Anonymous access to public route:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(app {:request-method :get, :uri "/api/ping"})
|
||||||
|
; {:status 200, :body "ok"}
|
||||||
|
```
|
||||||
|
|
||||||
|
Anonymous access to guarded route:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(app {:request-method :get, :uri "/api/admin/ping"})
|
||||||
|
; {:status 403, :body "forbidden"}
|
||||||
|
```
|
||||||
|
|
||||||
|
Authorized access to guarded route:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(app {:request-method :get, :uri "/api/admin/ping", ::roles #{:admin}})
|
||||||
|
; {:status 200, :body "ok"}
|
||||||
|
```
|
||||||
|
|
||||||
## Validating route-tree
|
## Validating route-tree
|
||||||
|
|
||||||
**TODO**
|
**TODO**
|
||||||
|
|
@ -297,10 +350,6 @@ Ring-router supports also 3-arity [Async Ring](https://www.booleanknot.com/blog/
|
||||||
|
|
||||||
**TODO**
|
**TODO**
|
||||||
|
|
||||||
## Custom extensions
|
|
||||||
|
|
||||||
**TODO**
|
|
||||||
|
|
||||||
## Configuring Routers
|
## Configuring Routers
|
||||||
|
|
||||||
Routers can be configured via options to do things like custom coercion and compilatin of meta-data. These can be used to do things like [`clojure.spec`](https://clojure.org/about/spec) validation of meta-data and fast, compiled [Ring](https://github.com/ring-clojure/ring/wiki/Concepts) or [Pedestal](http://pedestal.io/) -style handlers.
|
Routers can be configured via options to do things like custom coercion and compilatin of meta-data. These can be used to do things like [`clojure.spec`](https://clojure.org/about/spec) validation of meta-data and fast, compiled [Ring](https://github.com/ring-clojure/ring/wiki/Concepts) or [Pedestal](http://pedestal.io/) -style handlers.
|
||||||
|
|
|
||||||
|
|
@ -130,6 +130,7 @@
|
||||||
(if (and (seq required) (not (set/intersection required roles)))
|
(if (and (seq required) (not (set/intersection required roles)))
|
||||||
{:status 403, :body "forbidden"}
|
{:status 403, :body "forbidden"}
|
||||||
(handler request)))))
|
(handler request)))))
|
||||||
|
|
||||||
(deftest enforcing-meta-data-rules-at-runtime-test
|
(deftest enforcing-meta-data-rules-at-runtime-test
|
||||||
(let [handler (constantly {:status 200, :body "ok"})
|
(let [handler (constantly {:status 200, :body "ok"})
|
||||||
app (ring/ring-handler
|
app (ring/ring-handler
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue