2017-10-31 08:26:41 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > Data-driven Middleware · 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 = "dynamic_extensions.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" data-path = "../basics/" >
< a href = "../basics/" >
Basics
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "../basics/route_syntax.html" >
< a href = "../basics/route_syntax.html" >
Route syntax
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "../basics/router.html" >
< a href = "../basics/router.html" >
Router
< / a >
< / li >
< li class = "chapter " data-level = "1.2.3" data-path = "../basics/path_based_routing.html" >
< a href = "../basics/path_based_routing.html" >
Path-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "1.2.4" data-path = "../basics/name_based_routing.html" >
< a href = "../basics/name_based_routing.html" >
Name-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "1.2.5" data-path = "../basics/route_data.html" >
< a href = "../basics/route_data.html" >
Route data
< / a >
< / li >
< li class = "chapter " data-level = "1.2.6" data-path = "../basics/route_conflicts.html" >
< a href = "../basics/route_conflicts.html" >
Route conflicts
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.3" data-path = "../advanced/" >
< a href = "../advanced/" >
Advanced
< / a >
< ul class = "articles" >
2017-11-01 07:29:38 +00:00
< li class = "chapter " data-level = "1.3.1" data-path = "../advanced/configuring_routers.html" >
2017-10-31 08:26:41 +00:00
2017-11-01 07:29:38 +00:00
< a href = "../advanced/configuring_routers.html" >
2017-10-31 08:26:41 +00:00
2017-11-01 07:29:38 +00:00
Configuring routers
2017-10-31 08:26:41 +00:00
< / a >
< / li >
< li class = "chapter " data-level = "1.3.2" data-path = "../advanced/different_routers.html" >
< a href = "../advanced/different_routers.html" >
Different Routers
< / a >
< / li >
2017-11-01 07:29:38 +00:00
< li class = "chapter " data-level = "1.3.3" data-path = "../advanced/route_validation.html" >
2017-10-31 08:26:41 +00:00
2017-11-01 07:29:38 +00:00
< a href = "../advanced/route_validation.html" >
2017-10-31 08:26:41 +00:00
2017-11-01 07:29:38 +00:00
Route Validation
2017-10-31 08:26:41 +00:00
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" data-path = "./" >
< a href = "./" >
Ring
< / a >
< 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 " data-level = "1.4.2" data-path = "dynamic_extensions.html" >
< a href = "dynamic_extensions.html" >
Dynamic extensions
< / a >
< / li >
< li class = "chapter active" data-level = "1.4.3" data-path = "data_driven_middleware.html" >
< a href = "data_driven_middleware.html" >
Data-driven Middleware
< / a >
< / li >
< li class = "chapter " data-level = "1.4.4" data-path = "parameter_coercion.html" >
< a href = "parameter_coercion.html" >
Parameter coercion
< / a >
< / li >
< li class = "chapter " data-level = "1.4.5" data-path = "compiling_middleware.html" >
< a href = "compiling_middleware.html" >
Compiling middleware
< / a >
< / li >
< / ul >
< / li >
2017-11-01 07:29:38 +00:00
< li class = "chapter " data-level = "1.5" data-path = "../performance.html" >
< a href = "../performance.html" >
Performance
< / a >
< / li >
< li class = "chapter " data-level = "1.6" >
2017-10-31 08:26:41 +00:00
< span >
TODO: Swagger & OpenAPI
< / span >
< / li >
2017-11-01 07:29:38 +00:00
< li class = "chapter " data-level = "1.7" >
2017-10-31 08:26:41 +00:00
< 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 = ".." > Data-driven Middleware< / 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 = "data-driven-middleware" > Data-driven Middleware< / h1 >
< p > Reitit supports first-class data-driven middleware via < code > reitit.ring.middleware/Middleware< / code > records, created with < code > reitit.ring.middleware/create< / code > function. The following keys have special purpose:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > :name< / code > < / td >
< td > Name of the middleware as qualified keyword (optional,recommended for libs)< / td >
< / tr >
< tr >
< td > < code > :wrap< / code > < / td >
< td > The actual middleware function of < code > handler args? => request => response< / code > < / td >
< / tr >
< tr >
< td > < code > :gen< / code > < / td >
< td > Middleware compile function, see < a href = "compiling_middleware.html" > compiling middleware< / a > .< / td >
< / tr >
< / tbody >
< / table >
< p > When routes are compiled, all middleware are expanded (and optionally compiled) into < code > Middleware< / code > Records and stored in compilation results for later use (api-docs etc). For actual request processing, they are unwrapped into normal middleware functions and composed together producing zero runtime performance penalty. Middleware expansion is backed by < code > reitit.middleware/IntoMiddleware< / code > protocol, enabling plain clojure(script) maps to be used.< / p >
< p > A Record:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.middleware < span class = "hljs-symbol" > :as< / span > middleware])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > wrap2
(< span class = "hljs-name" > middleware/create< / span >
{< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::wrap2< / span >
< span class = "hljs-symbol" > :description< / span > < span class = "hljs-string" > " a nice little mw, takes 1 arg." < / span >
< span class = "hljs-symbol" > :wrap< / span > wrap}))
< / code > < / pre >
< p > As plain map:< / p >
< pre > < code class = "lang-clj" > < span class = "hljs-comment" > ;; plain map< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > wrap3
{< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::wrap3< / span >
< span class = "hljs-symbol" > :description< / span > < span class = "hljs-string" > " a nice little mw, :api as arg" < / span >
< span class = "hljs-symbol" > :wrap< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [handler]
(< span class = "hljs-name" > wrap< / span > handler < span class = "hljs-symbol" > :api< / span > ))})
< / code > < / pre >
< h3 id = "todo" > TODO< / h3 >
< p > more!< / p >
< / 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 = "dynamic_extensions.html" class = "navigation navigation-prev " aria-label = "Previous page: Dynamic extensions" >
< 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-11-01 08:18:52 +00:00
gitbook.page.hasChanged({"page":{"title":"Data-driven Middleware","level":"1.4.3","depth":2,"next":{"title":"Parameter coercion","level":"1.4.4","depth":2,"path":"ring/parameter_coercion.md","ref":"ring/parameter_coercion.md","articles":[]},"previous":{"title":"Dynamic extensions","level":"1.4.2","depth":2,"path":"ring/dynamic_extensions.md","ref":"ring/dynamic_extensions.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":"ring/data_driven_middleware.md","mtime":"2017-11-01T08:18:11.358Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2017-11-01T08:18:49.296Z"},"basePath":"..","book":{"language":""}});
2017-10-31 08:26:41 +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 >
