2017-09-18 05:30:53 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > Dynamic extensions · GitBook< / title >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" / >
< meta name = "description" content = "" >
< meta name = "generator" content = "GitBook 3.2.3" >
< link rel = "stylesheet" href = "gitbook/style.css" >
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-highlight/website.css" >
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-search/search.css" >
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-fontsettings/website.css" >
< meta name = "HandheldFriendly" content = "true" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1, user-scalable=no" >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< meta name = "apple-mobile-web-app-status-bar-style" content = "black" >
< link rel = "apple-touch-icon-precomposed" sizes = "152x152" href = "gitbook/images/apple-touch-icon-precomposed-152.png" >
< link rel = "shortcut icon" href = "gitbook/images/favicon.ico" type = "image/x-icon" >
< link rel = "next" href = "parameter_coercion.html" / >
< link rel = "prev" href = "ring.html" / >
< / head >
< body >
< div class = "book" >
< div class = "book-summary" >
< div id = "book-search-input" role = "search" >
< input type = "text" placeholder = "Type to search" / >
< / div >
< nav role = "navigation" >
< ul class = "summary" >
< li class = "chapter " data-level = "1.1" data-path = "./" >
< a href = "./" >
Introduction
< / a >
< / li >
< li class = "chapter " data-level = "1.2" >
< span >
Basics
< / span >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "basics.html" >
< a href = "basics.html#route-syntax" >
Route syntax
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "basics.html" >
< a href = "basics.html#router" >
Router
< / a >
< / li >
< li class = "chapter " data-level = "1.2.3" data-path = "basics.html" >
< a href = "basics.html#path-based-routing" >
Path-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "1.2.4" data-path = "basics.html" >
< a href = "basics.html#name-based-routing" >
Name-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "1.2.5" data-path = "basics.html" >
< a href = "basics.html#route-data" >
Route data
< / a >
< / li >
< li class = "chapter " data-level = "1.2.6" data-path = "basics.html" >
< a href = "basics.html#different-routers" >
Different Routers
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.3" >
< span >
Advanced
< / span >
< ul class = "articles" >
< li class = "chapter " data-level = "1.3.1" data-path = "route_conflicts.html" >
< a href = "route_conflicts.html" >
Route conflicts
< / a >
< / li >
< li class = "chapter " data-level = "1.3.2" data-path = "route_validation.html" >
< a href = "route_validation.html" >
Route Validation
< / a >
< / li >
< li class = "chapter " data-level = "1.3.3" data-path = "configuring_routers.html" >
< a href = "configuring_routers.html" >
Configuring routers
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" >
< span >
Ring
< / span >
< ul class = "articles" >
< li class = "chapter " data-level = "1.4.1" data-path = "ring.html" >
< a href = "ring.html" >
Ring-router
< / a >
< / li >
< li class = "chapter active" data-level = "1.4.2" data-path = "dynamic_extensions.html" >
< a href = "dynamic_extensions.html" >
Dynamic extensions
< / a >
< / li >
< li class = "chapter " data-level = "1.4.3" data-path = "parameter_coercion.html" >
< a href = "parameter_coercion.html" >
Parameter coercion
< / a >
< / li >
< li class = "chapter " data-level = "1.4.4" data-path = "compiling_middleware.html" >
< a href = "compiling_middleware.html" >
Compiling middleware
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" >
< span >
TODO: Swagger & OpenAPI
< / span >
< / li >
< li class = "chapter " data-level = "1.6" >
< span >
TODO: Interceptors
< / span >
< / li >
< li class = "divider" > < / li >
< li >
< a href = "https://www.gitbook.com" target = "blank" class = "gitbook-link" >
Published with GitBook
< / a >
< / li >
< / ul >
< / nav >
< / div >
< div class = "book-body" >
< div class = "body-inner" >
< div class = "book-header" role = "navigation" >
<!-- Title -->
< h1 >
< i class = "fa fa-circle-o-notch fa-spin" > < / i >
< a href = "." > Dynamic extensions< / a >
< / h1 >
< / div >
< div class = "page-wrapper" tabindex = "-1" role = "main" >
< div class = "page-inner" >
< div id = "book-search-results" >
< div class = "search-noresults" >
< section class = "normal markdown-section" >
< h1 id = "dynamic-extensions" > Dynamic extensions< / h1 >
< p > < code > ring-handler< / code > injects the < code > Match< / code > into a request and it can be extracted at runtime with < code > reitit.ring/get-match< / code > . This can be used to build dynamic extensions to the system.< / p >
< p > Example middleware to guard routes based on user roles:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [clojure.set < span class = "hljs-symbol" > :as< / span > set])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > wrap-enforce-roles [handler]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{< span class = "hljs-symbol" > :keys< / span > [< span class = "hljs-symbol" > ::roles< / span > ] < span class = "hljs-symbol" > :as< / span > request}]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > let< / span > < / span > [required (< span class = "hljs-name" > some-> < / span > request (< span class = "hljs-name" > ring/get-match< / span > ) < span class = "hljs-symbol" > :meta< / span > < span class = "hljs-symbol" > ::roles< / span > )]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > if< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > and< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > seq< / span > < / span > required) (< span class = "hljs-name" > < span class = "hljs-builtin-name" > not< / span > < / span > (< span class = "hljs-name" > set/intersection< / span > required roles)))
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 403< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " forbidden" < / span > }
(< span class = "hljs-name" > handler< / span > request)))))
< / code > < / pre >
< p > Mounted to an app via router meta-data (effecting all routes):< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > handler (< span class = "hljs-name" > < span class = "hljs-builtin-name" > constantly< / span > < / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " ok" < / span > }))
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > app
(< span class = "hljs-name" > ring/ring-handler< / span >
(< span class = "hljs-name" > ring/router< / span >
[[< span class = "hljs-string" > " /api" < / span >
[< span class = "hljs-string" > " /ping" < / span > handler]
[< span class = "hljs-string" > " /admin" < / span > {< span class = "hljs-symbol" > ::roles< / span > #{< span class = "hljs-symbol" > :admin< / span > }}
[< span class = "hljs-string" > " /ping" < / span > handler]]]]
{< span class = "hljs-symbol" > :meta< / span > {< span class = "hljs-symbol" > :middleware< / span > [wrap-enforce-roles]}})))
< / code > < / pre >
< p > Anonymous access to public route:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api/ping" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body " ok" }< / span >
< / code > < / pre >
< p > Anonymous access to guarded route:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api/admin/ping" < / span > })
< span class = "hljs-comment" > ; {:status 403, :body " forbidden" }< / span >
< / code > < / pre >
< p > Authorized access to guarded route:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api/admin/ping" < / span > , < span class = "hljs-symbol" > ::roles< / span > #{< span class = "hljs-symbol" > :admin< / span > }})
< span class = "hljs-comment" > ; {:status 200, :body " ok" }< / span >
< / code > < / pre >
< / section >
< / div >
< div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > results matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< a href = "ring.html" class = "navigation navigation-prev " aria-label = "Previous page: Ring-router" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "parameter_coercion.html" class = "navigation navigation-next " aria-label = "Next page: Parameter coercion" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2017-10-02 14:57:12 +00:00
gitbook.page.hasChanged({"page":{"title":"Dynamic extensions","level":"1.4.2","depth":2,"next":{"title":"Parameter coercion","level":"1.4.3","depth":2,"path":"parameter_coercion.md","ref":"parameter_coercion.md","articles":[]},"previous":{"title":"Ring-router","level":"1.4.1","depth":2,"path":"ring.md","ref":"ring.md","articles":[]},"dir":"ltr"},"config":{"plugins":["editlink","github","highlight"],"root":"doc","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"github":{"url":"https://github.com/metosin/reitit"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"*"},"file":{"path":"dynamic_extensions.md","mtime":"2017-10-02T14:56:41.014Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2017-10-02T14:57:10.957Z"},"basePath":".","book":{"language":""}});
2017-09-18 05:30:53 +00:00
});
< / script >
< / div >
< script src = "gitbook/gitbook.js" > < / script >
< script src = "gitbook/theme.js" > < / script >
< script src = "gitbook/gitbook-plugin-editlink/plugin.js" > < / script >
< script src = "gitbook/gitbook-plugin-github/plugin.js" > < / script >
< script src = "gitbook/gitbook-plugin-search/search-engine.js" > < / script >
< script src = "gitbook/gitbook-plugin-search/search.js" > < / script >
< script src = "gitbook/gitbook-plugin-lunr/lunr.min.js" > < / script >
< script src = "gitbook/gitbook-plugin-lunr/search-lunr.js" > < / script >
< script src = "gitbook/gitbook-plugin-sharing/buttons.js" > < / script >
< script src = "gitbook/gitbook-plugin-fontsettings/fontsettings.js" > < / script >
< / body >
< / html >
