2018-08-03 07:10:16 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > Default 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 = "coercion.html" / >
< link rel = "prev" href = "middleware_registry.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_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 >
< 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" >
< a href = "../advanced/different_routers.html" >
Different Routers
< / a >
< / li >
< li class = "chapter " data-level = "1.4.4" data-path = "../advanced/route_validation.html" >
< a href = "../advanced/route_validation.html" >
Route Validation
< / a >
< / li >
< li class = "chapter " data-level = "1.4.5" data-path = "../advanced/dev_workflow.html" >
< a href = "../advanced/dev_workflow.html" >
Dev Workflow
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" data-path = "./" >
< a href = "./" >
Ring
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.5.1" data-path = "ring.html" >
< a href = "ring.html" >
Ring-router
< / a >
< / li >
< li class = "chapter " data-level = "1.5.2" data-path = "reverse_routing.html" >
< a href = "reverse_routing.html" >
Reverse-routing
< / a >
< / li >
< li class = "chapter " data-level = "1.5.3" data-path = "default_handler.html" >
< a href = "default_handler.html" >
Default handler
< / a >
< / li >
< li class = "chapter " data-level = "1.5.4" data-path = "static.html" >
< a href = "static.html" >
Static Resources
< / a >
< / li >
< li class = "chapter " data-level = "1.5.5" data-path = "dynamic_extensions.html" >
< a href = "dynamic_extensions.html" >
Dynamic Extensions
< / a >
< / li >
< li class = "chapter " data-level = "1.5.6" data-path = "data_driven_middleware.html" >
< a href = "data_driven_middleware.html" >
Data-driven Middleware
< / a >
< / li >
< li class = "chapter " data-level = "1.5.7" data-path = "middleware_registry.html" >
< a href = "middleware_registry.html" >
Middleware Registry
< / a >
< / li >
< li class = "chapter active" data-level = "1.5.8" data-path = "default_middleware.html" >
< a href = "default_middleware.html" >
Default Middleware
< / a >
< / li >
< li class = "chapter " data-level = "1.5.9" data-path = "coercion.html" >
< a href = "coercion.html" >
Pluggable Coercion
< / a >
< / li >
< li class = "chapter " data-level = "1.5.10" data-path = "route_data_validation.html" >
< a href = "route_data_validation.html" >
Route Data Validation
< / a >
< / li >
< li class = "chapter " data-level = "1.5.11" data-path = "compiling_middleware.html" >
< a href = "compiling_middleware.html" >
Compiling Middleware
< / a >
< / li >
< li class = "chapter " data-level = "1.5.12" data-path = "swagger.html" >
< a href = "swagger.html" >
Swagger Support
< / a >
< / li >
< / ul >
< / li >
< 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" >
< a href = "../performance.html" >
Performance
< / a >
< / li >
< li class = "chapter " data-level = "1.8" data-path = "../interceptors.html" >
< a href = "../interceptors.html" >
Interceptors (WIP)
< / a >
< / li >
< li class = "chapter " data-level = "1.9" data-path = "../development.html" >
< a href = "../development.html" >
Development Instructions
< / a >
< / li >
< li class = "chapter " data-level = "1.10" data-path = "../faq.html" >
< 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 >
< a href = ".." > Default 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 = "default-middleware" > Default Middleware< / h1 >
< pre > < code class = "lang-clj" > [metosin/reitit-middleware < span class = "hljs-string" > " 0.2.0-SNAPSHOT" < / span > ]
< / code > < / pre >
< p > Any Ring middleware can be used with < code > reitit-ring< / code > , but using data-driven middleware is preferred as they are easier to manage and in many cases, yield better performance. < code > reitit-middleware< / code > contains a set of common ring middleware, lifted into data-driven middleware.< / p >
< ul >
< li > < a href = "#exception-handling" > Exception handling< / a > < / li >
< li > < a href = "#content-negotiation" > Content negotiation< / a > < / li >
< li > < a href = "#multipart-request-handling" > Multipart request handling< / a > < / li >
< / ul >
< h2 id = "exception-handling" > Exception handling< / h2 >
< p > A polished version of < a href = "https://github.com/metosin/compojure-api" target = "_blank" > compojure-api< / a > exception handling. Catches all exceptions and invokes configured exception handler.< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring.middleware.exception < span class = "hljs-symbol" > :as< / span > exception])
< / code > < / pre >
< h3 id = "exceptionexception-middleware" > < code > exception/exception-middleware< / code > < / h3 >
< p > A preconfigured middleware using < code > exception/default-handlers< / code > . Catches:< / p >
< ul >
< li > Request & response < a href = "coercion.html" > Coercion< / a > exceptions< / li >
< li > < a href = "https://github.com/metosin/muuntaja" target = "_blank" > Muuntaja< / a > decode exceptions< / li >
< li > Exceptions with < code > :type< / code > of < code > :reitit.ring/response< / code > , returning < code > :response< / code > key from < code > ex-data< / code > .< / li >
< li > Safely all other exceptions< / li >
< / ul >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring < span class = "hljs-symbol" > :as< / span > ring])
(< 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" > " /fail" < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [_] (< span class = "hljs-name" > < span class = "hljs-builtin-name" > throw< / span > < / span > (< span class = "hljs-name" > Exception.< / span > < span class = "hljs-string" > " fail" < / span > )))]
{< span class = "hljs-symbol" > :data< / span > {< span class = "hljs-symbol" > :middleware< / span > [exception/exception-middleware]}})))
(< 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" > " /fail" < / span > })
< span class = "hljs-comment" > ;{:status 500< / span >
< span class = "hljs-comment" > ; :body {:type " exception" < / span >
< span class = "hljs-comment" > ; :class " java.lang.Exception" }}< / span >
< / code > < / pre >
< h3 id = "exceptioncreate-exception-middleware" > < code > exception/create-exception-middleware< / code > < / h3 >
< p > Creates the exception-middleware with custom options. Takes a map of < code > identifier => exception request => response< / code > that is used to select the exception handler for the thown/raised exception identifier. Exception idenfier is either a < code > Keyword< / code > or a Exception Class.< / p >
< p > The following handlers special keys are available:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2018-08-03 10:32:15 +00:00
< td > < code > ::exception/default< / code > < / td >
2018-08-03 07:10:16 +00:00
< td > a default exception handler if nothing else mathced (default < code > exception/default-handler< / code > ).< / td >
< / tr >
< tr >
2018-08-03 10:32:15 +00:00
< td > < code > ::exception/wrap< / code > < / td >
2018-08-03 07:10:16 +00:00
< td > a 3-arity handler to wrap the actual handler < code > handler exception request => response< / code > (no default).< / td >
< / tr >
< / tbody >
< / table >
< p > The handler is selected from the options map by exception idenfitifier in the following lookup order:< / p >
< p > 1) < code > :type< / code > of exception ex-data
2) Class of exception
3) < code > :type< / code > ancestors of exception ex-data
4) Super Classes of exception
5) The ::default handler< / p >
< pre > < code class = "lang-clj" > < span class = "hljs-comment" > ;; type hierarchy< / span >
(< span class = "hljs-name" > derive< / span > < span class = "hljs-symbol" > ::error< / span > < span class = "hljs-symbol" > ::exception< / span > )
(< span class = "hljs-name" > derive< / span > < span class = "hljs-symbol" > ::failure< / span > < span class = "hljs-symbol" > ::exception< / span > )
(< span class = "hljs-name" > derive< / span > < span class = "hljs-symbol" > ::horror< / span > < span class = "hljs-symbol" > ::exception< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > handler [message exception request]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 500< / span >
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :message< / span > message
< span class = "hljs-symbol" > :exception< / span > (< span class = "hljs-name" > .getClass< / span > exception)
< span class = "hljs-symbol" > :data< / span > (< span class = "hljs-name" > ex-data< / span > exception)
< span class = "hljs-symbol" > :uri< / span > (< span class = "hljs-symbol" > :uri< / span > request)}})
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > exception-middleware
(< span class = "hljs-name" > exception/create-exception-middleware< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > merge< / span > < / span >
exception/default-handlers
{< span class = "hljs-comment" > ;; ex-data with :type ::error< / span >
< span class = "hljs-symbol" > ::error< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > partial< / span > < / span > handler < span class = "hljs-string" > " error" < / span > )
< span class = "hljs-comment" > ;; ex-data with ::exception or ::failure< / span >
< span class = "hljs-symbol" > ::exception< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > partial< / span > < / span > handler < span class = "hljs-string" > " exception" < / span > )
< span class = "hljs-comment" > ;; SQLException and all it' s child classes< / span >
java.sql.SQLException (< span class = "hljs-name" > < span class = "hljs-builtin-name" > partial< / span > < / span > handler < span class = "hljs-string" > " sql-exception" < / span > )
< span class = "hljs-comment" > ;; override the default handler< / span >
< span class = "hljs-symbol" > ::exception/default< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > partial< / span > < / span > handler < span class = "hljs-string" > " default" < / span > )
< span class = "hljs-comment" > ;; print stack-traces for all exceptions< / span >
< span class = "hljs-symbol" > ::exception/wrap< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [handler e request]
(< span class = "hljs-name" > println< / span > < span class = "hljs-string" > " ERROR" < / span > (< span class = "hljs-name" > pr-str< / span > (< span class = "hljs-symbol" > :uri< / span > request)))
(< span class = "hljs-name" > handler< / span > e request))})))
(< 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" > " /fail" < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [_] (< span class = "hljs-name" > < span class = "hljs-builtin-name" > throw< / span > < / span > (< span class = "hljs-name" > ex-info< / span > < span class = "hljs-string" > " fail" < / span > {< span class = "hljs-symbol" > :type< / span > < span class = "hljs-symbol" > ::failue< / span > })))]
{< span class = "hljs-symbol" > :data< / span > {< span class = "hljs-symbol" > :middleware< / span > [exception-middleware]}})))
(< 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" > " /fail" < / span > })
< span class = "hljs-comment" > ; ERROR " /fail" < / span >
< span class = "hljs-comment" > ; => {:status 500,< / span >
< span class = "hljs-comment" > ; :body {:message " default" < / span >
< span class = "hljs-comment" > ; :exception clojure.lang.ExceptionInfo< / span >
< span class = "hljs-comment" > ; :data {:type :user/failue}< / span >
< span class = "hljs-comment" > ; :uri " /fail" }}< / span >
< / code > < / pre >
< h2 id = "content-negotiation" > Content Negotiation< / h2 >
< p > Wrapper for < a href = "https://github.com/metosin/muuntaja" target = "_blank" > Muuntaja< / a > middleware for content-negotiation, request decoding and response encoding. Reads configuration from route data and emit' s < a href = "swagger.html" > swagger< / a > < code > :produces< / code > and < code > :consumes< / code > definitions automatically.< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring.middleware.muuntaja < span class = "hljs-symbol" > :as< / span > muuntaja])
< / code > < / pre >
< h2 id = "multipart-request-handling" > Multipart request handling< / h2 >
< p > Wrapper for < a href = "https://github.com/ring-clojure/ring/blob/master/ring-core/src/ring/middleware/multipart_params.clj" target = "_blank" > Ring Multipart Middleware< / a > . Conditionally mounts to an endpoint only if it has < code > :multipart< / code > params defined. Emits swagger < code > :consumes< / code > definitions automatically.< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring.middleware.multipart < span class = "hljs-symbol" > :as< / span > multipart])
< / code > < / pre >
< h2 id = "example-app" > Example app< / h2 >
< p > See an example app with the default middleware in action: < a href = "https://github.com/metosin/reitit/blob/master/examples/ring-swagger/src/example/server.clj" target = "_blank" > https://github.com/metosin/reitit/blob/master/examples/ring-swagger/src/example/server.clj< / a > .< / 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 = "middleware_registry.html" class = "navigation navigation-prev " aria-label = "Previous page: Middleware Registry" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "coercion.html" class = "navigation navigation-next " aria-label = "Next page: Pluggable Coercion" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-08-08 07:32:14 +00:00
gitbook.page.hasChanged({"page":{"title":"Default Middleware","level":"1.5.8","depth":2,"next":{"title":"Pluggable Coercion","level":"1.5.9","depth":2,"path":"ring/coercion.md","ref":"ring/coercion.md","articles":[]},"previous":{"title":"Middleware Registry","level":"1.5.7","depth":2,"path":"ring/middleware_registry.md","ref":"ring/middleware_registry.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/default_middleware.md","mtime":"2018-08-08T07:31:21.752Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-08-08T07:32:07.730Z"},"basePath":"..","book":{"language":""}});
2018-08-03 07:10:16 +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 >
