2018-02-02 12:49:20 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
2018-02-11 19:36:11 +00:00
< title > Interceptors (WIP) · GitBook< / title >
2018-02-02 12:49:20 +00:00
< 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" >
2018-05-20 16:52:28 +00:00
< link rel = "next" href = "development.html" / >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
< link rel = "prev" href = "performance.html" / >
2018-02-02 12:49:20 +00:00
< / 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_data_validation.html" >
< a href = "basics/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
< li class = "chapter " data-level = "1.2.7" 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 = "coercion/" >
< a href = "coercion/" >
Coercion
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.3.1" data-path = "coercion/coercion.html" >
< a href = "coercion/coercion.html" >
Coercion Explained
< / a >
< / li >
< li class = "chapter " data-level = "1.3.2" data-path = "coercion/schema_coercion.html" >
< a href = "coercion/schema_coercion.html" >
Plumatic Schema
< / a >
< / li >
< li class = "chapter " data-level = "1.3.3" data-path = "coercion/clojure_spec_coercion.html" >
< a href = "coercion/clojure_spec_coercion.html" >
Clojure.spec
< / a >
< / li >
< li class = "chapter " data-level = "1.3.4" data-path = "coercion/data_spec_coercion.html" >
< a href = "coercion/data_spec_coercion.html" >
Data-specs
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" data-path = "advanced/" >
< a href = "advanced/" >
Advanced
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.4.1" data-path = "advanced/configuring_routers.html" >
< a href = "advanced/configuring_routers.html" >
Configuring Routers
< / a >
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter " data-level = "1.4.2" data-path = "advanced/composing_routers.html" >
< a href = "advanced/composing_routers.html" >
Composing Routers
< / a >
< / li >
< li class = "chapter " data-level = "1.4.3" data-path = "advanced/different_routers.html" >
2018-02-02 12:49:20 +00:00
< a href = "advanced/different_routers.html" >
Different Routers
< / a >
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter " data-level = "1.4.4" data-path = "advanced/route_validation.html" >
2018-02-02 12:49:20 +00:00
< a href = "advanced/route_validation.html" >
Route Validation
< / a >
2018-03-15 06:09:15 +00:00
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter " data-level = "1.4.5" data-path = "advanced/dev_workflow.html" >
2018-03-15 06:09:15 +00:00
< a href = "advanced/dev_workflow.html" >
Dev Workflow
< / a >
2018-02-02 12:49:20 +00:00
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" data-path = "ring/" >
< a href = "ring/" >
Ring
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.5.1" data-path = "ring/ring.html" >
< a href = "ring/ring.html" >
Ring-router
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.2" data-path = "ring/reverse_routing.html" >
< a href = "ring/reverse_routing.html" >
Reverse-routing
< / a >
< / li >
< li class = "chapter " data-level = "1.5.3" data-path = "ring/default_handler.html" >
2018-04-25 18:13:54 +00:00
< a href = "ring/default_handler.html" >
Default handler
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.4" data-path = "ring/static.html" >
2018-04-25 09:50:40 +00:00
< a href = "ring/static.html" >
Static Resources
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.5" data-path = "ring/dynamic_extensions.html" >
2018-02-02 12:49:20 +00:00
< a href = "ring/dynamic_extensions.html" >
Dynamic Extensions
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.6" data-path = "ring/data_driven_middleware.html" >
2018-02-02 12:49:20 +00:00
< a href = "ring/data_driven_middleware.html" >
Data-driven Middleware
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.7" data-path = "ring/coercion.html" >
2018-02-02 12:49:20 +00:00
< a href = "ring/coercion.html" >
Pluggable Coercion
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.8" data-path = "ring/route_data_validation.html" >
2018-02-02 12:49:20 +00:00
< a href = "ring/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.9" data-path = "ring/compiling_middleware.html" >
2018-02-02 12:49:20 +00:00
< a href = "ring/compiling_middleware.html" >
Compiling Middleware
< / a >
2018-05-14 13:54:28 +00:00
< / li >
2018-06-14 10:29:02 +00:00
< li class = "chapter " data-level = "1.5.10" data-path = "ring/swagger.html" >
2018-05-14 13:54:28 +00:00
< a href = "ring/swagger.html" >
Swagger Support
< / a >
2018-02-02 12:49:20 +00:00
< / li >
< / ul >
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter " data-level = "1.6" data-path = "frontend/" >
< a href = "frontend/" >
Frontend
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1" data-path = "frontend/basics.html" >
< a href = "frontend/basics.html" >
Basics
< / a >
< / li >
< li class = "chapter " data-level = "1.6.2" data-path = "frontend/browser.html" >
< a href = "frontend/browser.html" >
Browser integration
< / a >
< / li >
< li class = "chapter " data-level = "1.6.3" data-path = "frontend/controllers.html" >
< a href = "frontend/controllers.html" >
Controllers
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.7" data-path = "performance.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
< a href = "performance.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
Performance
2018-02-02 12:49:20 +00:00
< / a >
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter active" data-level = "1.8" data-path = "interceptors.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
< a href = "interceptors.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
Interceptors (WIP)
2018-02-02 12:49:20 +00:00
< / a >
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter " data-level = "1.9" data-path = "development.html" >
2018-05-20 16:52:28 +00:00
< a href = "development.html" >
Development Instructions
< / a >
< / li >
2018-07-18 10:13:28 +00:00
< li class = "chapter " data-level = "1.10" data-path = "faq.html" >
2018-02-02 12:49:20 +00:00
< a href = "faq.html" >
FAQ
< / a >
< / 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 >
2018-02-11 19:36:11 +00:00
< a href = "." > Interceptors (WIP)< / a >
2018-02-02 12:49:20 +00:00
< / 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" >
2018-02-11 19:36:11 +00:00
< h1 id = "interceptors-wip" > Interceptors (WIP)< / h1 >
< p > Reitit has also support for < a href = "pedestal.io" > Pedestal< / a > -style < a href = "http://pedestal.io/reference/interceptors" target = "_blank" > interceptors< / a > via < code > reitit.interceptor< / code > package. Currently, there is no interceptor interpreter shipped, just a way to compose and manage the interceptor chains.< / p >
< p > Plan is to have a full-featured < code > reitit-http< / code > module with same features as the < code > reitit-ring< / code > - enchanced interceptor maps & interceptor compilations. Stay tuned.< / p >
< h3 id = "todo" > TODO< / h3 >
2018-02-02 12:49:20 +00:00
< ul >
2018-02-11 19:36:11 +00:00
< li > Figure out how to make a truly portable Interceptor definitions, e.g. Pedestal has namespaced keys for context errors, queues etc.< / li >
< li > Separate modules for interceptor interpreters (including cljs)< / li >
< li > Finalize < code > reitit-http< / code > module as an alternative to < code > reitit-ring< / code > < / li >
2018-02-02 12:49:20 +00:00
< / ul >
2018-02-11 19:36:11 +00:00
< h3 id = "example" > Example< / h3 >
2018-02-02 12:49:20 +00:00
< p > Current < code > reitit-http< / code > draft (with data-specs):< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.http.coercion < span class = "hljs-symbol" > :as< / span > rhc])
(< span class = "hljs-name" > require< / span > ' [reitit.http < span class = "hljs-symbol" > :as< / span > http])
(< span class = "hljs-name" > require< / span > ' [reitit.coercion.spec])
(< span class = "hljs-name" > require< / span > ' [clojure.set < span class = "hljs-symbol" > :as< / span > set])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > auth-interceptor
< span class = "hljs-string" > " Interceptor that mounts itself if route has `:roles` data. Expects `:roles`
to be a set of keyword and the context to have `[:user :roles]` with user roles.
responds with HTTP 403 if user doesn' t have the roles defined, otherwise no-op." < / span >
{< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::auth< / span >
< span class = "hljs-symbol" > :compile< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{< span class = "hljs-symbol" > :keys< / span > [roles]} _]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > if< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > seq< / span > < / span > roles)
{< span class = "hljs-symbol" > :description< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > str< / span > < / span > < span class = "hljs-string" > " requires roles " < / span > roles)
< span class = "hljs-symbol" > :spec< / span > {< span class = "hljs-symbol" > :roles< / span > #{keyword?}}
< span class = "hljs-symbol" > :context-spec< / span > {< span class = "hljs-symbol" > :user< / span > {< span class = "hljs-symbol" > :roles< / span > #{keyword}}}
< span class = "hljs-symbol" > :enter< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{{user-roles < span class = "hljs-symbol" > :roles< / span > } < span class = "hljs-symbol" > :user< / span > < span class = "hljs-symbol" > :as< / span > ctx}]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > if< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > not< / span > < / span > (< span class = "hljs-name" > set/subset?< / span > roles user-roles))
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > assoc< / span > < / span > ctx < span class = "hljs-symbol" > :response< / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 403< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " forbidden" < / span > })
ctx))}))})(< span class = "hljs-name" > require< / span > ' [clojure.set < span class = "hljs-symbol" > :as< / span > set])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > app
(< span class = "hljs-name" > http/http-handler< / span >
(< span class = "hljs-name" > http/router< / span >
[< span class = "hljs-string" > " /api" < / span > {< span class = "hljs-symbol" > :interceptors< / span > [auth-interceptor]}
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::ping< / span >
< span class = "hljs-symbol" > :get< / span > (< 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" > " pong" < / span > })}]
[< span class = "hljs-string" > " /plus/:z" < / span > {< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::plus< / span >
< span class = "hljs-symbol" > :post< / span > {< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :query< / span > {< span class = "hljs-symbol" > :x< / span > int?}
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :y< / span > int?}
< span class = "hljs-symbol" > :path< / span > {< span class = "hljs-symbol" > :z< / span > int?}}
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > pos-int?}}}
< span class = "hljs-symbol" > :roles< / span > #{< span class = "hljs-symbol" > :admin< / span > }
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{< span class = "hljs-symbol" > :keys< / span > [parameters]}]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > let< / span > < / span > [total (< span class = "hljs-name" > < span class = "hljs-builtin-name" > +< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :query< / span > < span class = "hljs-symbol" > :x< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :body< / span > < span class = "hljs-symbol" > :y< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :path< / span > < span class = "hljs-symbol" > :z< / span > ))]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span >
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > total}}))}}]]
{< span class = "hljs-symbol" > :data< / span > {< span class = "hljs-symbol" > :coercion< / span > reitit.coercion.spec/coercion
< span class = "hljs-symbol" > :interceptors< / span > [rhc/coerce-exceptions-interceptor
rhc/coerce-request-interceptor
rhc/coerce-response-interceptor]}})))
< / 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 >
2018-02-11 19:36:11 +00:00
< a href = "performance.html" class = "navigation navigation-prev " aria-label = "Previous page: Performance" >
2018-02-02 12:49:20 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2018-05-20 16:52:28 +00:00
< a href = "development.html" class = "navigation navigation-next " aria-label = "Next page: Development Instructions" >
2018-02-02 12:49:20 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-07-26 07:40:59 +00:00
gitbook.page.hasChanged({"page":{"title":"Interceptors (WIP)","level":"1.8","depth":1,"next":{"title":"Development Instructions","level":"1.9","depth":1,"path":"development.md","ref":"development.md","articles":[]},"previous":{"title":"Performance","level":"1.7","depth":1,"path":"performance.md","ref":"performance.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":"interceptors.md","mtime":"2018-07-26T07:40:18.066Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-07-26T07:40:53.641Z"},"basePath":".","book":{"language":""}});
2018-02-02 12:49:20 +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 >
