mirror of
https://github.com/metosin/reitit.git
synced 2025-12-20 01:21:11 +00:00
983 lines
32 KiB
HTML
983 lines
32 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Compiling 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-hints/plugin-hints.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="swagger.html" />
|
|
|
|
|
|
<link rel="prev" href="route_data_validation.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="header">Introduction</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Basics</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" data-path="../basics/route_syntax.html">
|
|
|
|
<a href="../basics/route_syntax.html">
|
|
|
|
|
|
Route Syntax
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2" data-path="../basics/router.html">
|
|
|
|
<a href="../basics/router.html">
|
|
|
|
|
|
Router
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="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="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="2.5" data-path="../basics/route_data.html">
|
|
|
|
<a href="../basics/route_data.html">
|
|
|
|
|
|
Route Data
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="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="2.7" data-path="../basics/route_conflicts.html">
|
|
|
|
<a href="../basics/route_conflicts.html">
|
|
|
|
|
|
Route Conflicts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.8" data-path="../basics/error_messages.html">
|
|
|
|
<a href="../basics/error_messages.html">
|
|
|
|
|
|
Error Messages
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Coercion</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="3.1" data-path="../coercion/coercion.html">
|
|
|
|
<a href="../coercion/coercion.html">
|
|
|
|
|
|
Coercion Explained
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.2" data-path="../coercion/schema_coercion.html">
|
|
|
|
<a href="../coercion/schema_coercion.html">
|
|
|
|
|
|
Plumatic Schema
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="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="3.4" data-path="../coercion/data_spec_coercion.html">
|
|
|
|
<a href="../coercion/data_spec_coercion.html">
|
|
|
|
|
|
Data-specs
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Ring</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="4.1" data-path="ring.html">
|
|
|
|
<a href="ring.html">
|
|
|
|
|
|
Ring-router
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.2" data-path="reverse_routing.html">
|
|
|
|
<a href="reverse_routing.html">
|
|
|
|
|
|
Reverse-routing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.3" data-path="default_handler.html">
|
|
|
|
<a href="default_handler.html">
|
|
|
|
|
|
Default handler
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.4" data-path="slash_handler.html">
|
|
|
|
<a href="slash_handler.html">
|
|
|
|
|
|
Slash handler
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.5" data-path="static.html">
|
|
|
|
<a href="static.html">
|
|
|
|
|
|
Static Resources
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.6" data-path="dynamic_extensions.html">
|
|
|
|
<a href="dynamic_extensions.html">
|
|
|
|
|
|
Dynamic Extensions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.7" data-path="data_driven_middleware.html">
|
|
|
|
<a href="data_driven_middleware.html">
|
|
|
|
|
|
Data-driven Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.8" data-path="transforming_middleware_chain.html">
|
|
|
|
<a href="transforming_middleware_chain.html">
|
|
|
|
|
|
Transforming Middleware Chain
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.9" data-path="middleware_registry.html">
|
|
|
|
<a href="middleware_registry.html">
|
|
|
|
|
|
Middleware Registry
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.10" data-path="exceptions.html">
|
|
|
|
<a href="exceptions.html">
|
|
|
|
|
|
Exception Handling with Ring
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.11" data-path="default_middleware.html">
|
|
|
|
<a href="default_middleware.html">
|
|
|
|
|
|
Default Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.12" data-path="content_negotiation.html">
|
|
|
|
<a href="content_negotiation.html">
|
|
|
|
|
|
Content Negotiation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.13" data-path="coercion.html">
|
|
|
|
<a href="coercion.html">
|
|
|
|
|
|
Pluggable Coercion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.14" data-path="route_data_validation.html">
|
|
|
|
<a href="route_data_validation.html">
|
|
|
|
|
|
Route Data Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="4.15" data-path="compiling_middleware.html">
|
|
|
|
<a href="compiling_middleware.html">
|
|
|
|
|
|
Compiling Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.16" data-path="swagger.html">
|
|
|
|
<a href="swagger.html">
|
|
|
|
|
|
Swagger Support
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.17" data-path="RESTful_form_methods.html">
|
|
|
|
<a href="RESTful_form_methods.html">
|
|
|
|
|
|
RESTful form methods
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">HTTP</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="5.1" data-path="../http/interceptors.html">
|
|
|
|
<a href="../http/interceptors.html">
|
|
|
|
|
|
Interceptors
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.2" data-path="../http/pedestal.html">
|
|
|
|
<a href="../http/pedestal.html">
|
|
|
|
|
|
Pedestal
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.3" data-path="../http/sieppari.html">
|
|
|
|
<a href="../http/sieppari.html">
|
|
|
|
|
|
Sieppari
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.4" data-path="../http/default_interceptors.html">
|
|
|
|
<a href="../http/default_interceptors.html">
|
|
|
|
|
|
Default Interceptors
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.5" data-path="../http/transforming_interceptor_chain.html">
|
|
|
|
<a href="../http/transforming_interceptor_chain.html">
|
|
|
|
|
|
Transforming Interceptor Chain
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Frontend</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="6.1" data-path="../frontend/basics.html">
|
|
|
|
<a href="../frontend/basics.html">
|
|
|
|
|
|
Basics
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="6.2" data-path="../frontend/browser.html">
|
|
|
|
<a href="../frontend/browser.html">
|
|
|
|
|
|
Browser integration
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="6.3" data-path="../frontend/controllers.html">
|
|
|
|
<a href="../frontend/controllers.html">
|
|
|
|
|
|
Controllers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Advanced</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="7.1" data-path="../advanced/configuring_routers.html">
|
|
|
|
<a href="../advanced/configuring_routers.html">
|
|
|
|
|
|
Configuring Routers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="7.2" data-path="../advanced/composing_routers.html">
|
|
|
|
<a href="../advanced/composing_routers.html">
|
|
|
|
|
|
Composing Routers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="7.3" data-path="../advanced/different_routers.html">
|
|
|
|
<a href="../advanced/different_routers.html">
|
|
|
|
|
|
Different Routers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="7.4" data-path="../advanced/route_validation.html">
|
|
|
|
<a href="../advanced/route_validation.html">
|
|
|
|
|
|
Route Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="7.5" data-path="../advanced/dev_workflow.html">
|
|
|
|
<a href="../advanced/dev_workflow.html">
|
|
|
|
|
|
Dev Workflow
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="7.6" data-path="../advanced/shared_routes.html">
|
|
|
|
<a href="../advanced/shared_routes.html">
|
|
|
|
|
|
Shared Routes
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Misc</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="8.1" data-path="../performance.html">
|
|
|
|
<a href="../performance.html">
|
|
|
|
|
|
Performance
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="8.2" data-path="../development.html">
|
|
|
|
<a href="../development.html">
|
|
|
|
|
|
Development Instructions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="8.3" 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=".." >Compiling 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="compiling-middleware">Compiling Middleware</h1>
|
|
<p>The <a href="dynamic_extensions.html">dynamic extensions</a> is a easy way to extend the system. To enable fast lookups into route data, we can compile them into any shape (records, functions etc.) we want, enabling fast access at request-time.</p>
|
|
<p>But, we can do much better. As we know the exact route that middleware/interceptor is linked to, we can pass the (compiled) route information into the middleware at creation-time. It can do local reasoning: extract and transform relevant data just for it and pass the optimized data into the actual request-handler via a closure - yielding much faster runtime processing. Middleware can also decide not to mount itself by returning <code>nil</code>. Why mount a <code>wrap-enforce-roles</code> middleware for a route if there are no roles required for it?</p>
|
|
<p>To enable this we use <a href="data_driven_middleware.html">middleware records</a> <code>:compile</code> key instead of the normal <code>:wrap</code>. <code>:compile</code> expects a function of <code>route-data router-opts => ?IntoMiddleware</code>.</p>
|
|
<p>To demonstrate the two approaches, below are response coercion middleware written as normal ring middleware function and as middleware record with <code>:compile</code>.</p>
|
|
<h2 id="normal-middleware">Normal Middleware</h2>
|
|
<ul>
|
|
<li>Reads the compiled route information on every request. Everything is done at request-time.</li>
|
|
</ul>
|
|
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">defn</span></span> wrap-coerce-response
|
|
<span class="hljs-string">"Middleware for pluggable response coercion.
|
|
Expects a :coercion of type `reitit.coercion/Coercion`
|
|
and :responses from route data, otherwise will do nothing."</span>
|
|
[handler]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span>
|
|
([request]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">let</span></span> [response (<span class="hljs-name">handler</span> request)
|
|
method (<span class="hljs-symbol">:request-method</span> request)
|
|
match (<span class="hljs-name">ring/get-match</span> request)
|
|
responses (<span class="hljs-name"><span class="hljs-builtin-name">-></span></span> match <span class="hljs-symbol">:result</span> method <span class="hljs-symbol">:data</span> <span class="hljs-symbol">:responses</span>)
|
|
coercion (<span class="hljs-name"><span class="hljs-builtin-name">-></span></span> match <span class="hljs-symbol">:data</span> <span class="hljs-symbol">:coercion</span>)
|
|
opts (<span class="hljs-name"><span class="hljs-builtin-name">-></span></span> match <span class="hljs-symbol">:data</span> <span class="hljs-symbol">:opts</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> coercion responses)
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">let</span></span> [coercers (<span class="hljs-name">response-coercers</span> coercion responses opts)]
|
|
(<span class="hljs-name">coerce-response</span> coercers request response))
|
|
response)))
|
|
([request respond raise]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">let</span></span> [method (<span class="hljs-symbol">:request-method</span> request)
|
|
match (<span class="hljs-name">ring/get-match</span> request)
|
|
responses (<span class="hljs-name"><span class="hljs-builtin-name">-></span></span> match <span class="hljs-symbol">:result</span> method <span class="hljs-symbol">:data</span> <span class="hljs-symbol">:responses</span>)
|
|
coercion (<span class="hljs-name"><span class="hljs-builtin-name">-></span></span> match <span class="hljs-symbol">:data</span> <span class="hljs-symbol">:coercion</span>)
|
|
opts (<span class="hljs-name"><span class="hljs-builtin-name">-></span></span> match <span class="hljs-symbol">:data</span> <span class="hljs-symbol">:opts</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> coercion responses)
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">let</span></span> [coercers (<span class="hljs-name">response-coercers</span> coercion responses opts)]
|
|
(<span class="hljs-name">handler</span> request #(<span class="hljs-name">respond</span> (<span class="hljs-name">coerce-response</span> coercers request %))))
|
|
(<span class="hljs-name">handler</span> request respond raise))))))
|
|
</code></pre>
|
|
<h2 id="compiled-middleware">Compiled Middleware</h2>
|
|
<ul>
|
|
<li>Route information is provided at creation-time</li>
|
|
<li>Coercers are compiled at creation-time</li>
|
|
<li>Middleware mounts only if <code>:coercion</code> and <code>:responses</code> are defined for the route</li>
|
|
<li>Also defines spec for the route data <code>:responses</code> for the <a href="route_data_validation.html">route data validation</a>.</li>
|
|
</ul>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">require</span> '[reitit.spec <span class="hljs-symbol">:as</span> rs])
|
|
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> coerce-response-middleware
|
|
<span class="hljs-string">"Middleware for pluggable response coercion.
|
|
Expects a :coercion of type `reitit.coercion/Coercion`
|
|
and :responses from route data, otherwise does not mount."</span>
|
|
{<span class="hljs-symbol">:name</span> <span class="hljs-symbol">::coerce-response</span>
|
|
<span class="hljs-symbol">:spec</span> <span class="hljs-symbol">::rs/responses</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> [coercion responses]} opts]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">if</span></span> (<span class="hljs-name"><span class="hljs-builtin-name">and</span></span> coercion responses)
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">let</span></span> [coercers (<span class="hljs-name">coercion/response-coercers</span> coercion responses opts)]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [handler]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span>
|
|
([request]
|
|
(<span class="hljs-name">coercion/coerce-response</span> coercers request (<span class="hljs-name">handler</span> request)))
|
|
([request respond raise]
|
|
(<span class="hljs-name">handler</span> request #(<span class="hljs-name">respond</span> (<span class="hljs-name">coercion/coerce-response</span> coercers request %)) raise)))))))})
|
|
</code></pre>
|
|
<p>It has 50% less code, it's much easier to reason about and is much faster.</p>
|
|
<h3 id="require-keys-on-routes-at-creation-time">Require Keys on Routes at Creation Time</h3>
|
|
<p>Often it is useful to require a route to provide a specific key.</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">require</span> '[buddy.auth.accessrules <span class="hljs-symbol">:as</span> accessrules])
|
|
|
|
(<span class="hljs-name">s/def</span> <span class="hljs-symbol">::authorize</span>
|
|
(<span class="hljs-name">s/or</span> <span class="hljs-symbol">:handler</span> <span class="hljs-symbol">:accessrules/handler</span> <span class="hljs-symbol">:rule</span> <span class="hljs-symbol">:accessrules/rule</span>))
|
|
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> authorization-middleware
|
|
{<span class="hljs-symbol">:name</span> <span class="hljs-symbol">::authorization</span>
|
|
<span class="hljs-symbol">:spec</span> (<span class="hljs-name">s/keys</span> <span class="hljs-symbol">:req-un</span> [<span class="hljs-symbol">::authorize</span>])
|
|
<span class="hljs-symbol">:compile</span>
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [route-data _opts]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">when-let</span></span> [rule (<span class="hljs-symbol">:authorize</span> route-data)]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [handler]
|
|
(<span class="hljs-name">accessrules/wrap-access-rules</span> handler {<span class="hljs-symbol">:rules</span> [rule]}))))})
|
|
</code></pre>
|
|
<p>In the example above the <code>:spec</code> expresses that each route is required to provide the <code>:authorize</code> key. However, in this case the compile function returns <code>nil</code> when that key is missing, which means <strong>the middleware will not be mounted, the spec will not be considered, and the compiler will not enforce this requirement as intended</strong>.</p>
|
|
<p>If you just want to enforce the spec return a map without <code>:wrap</code> or <code>:compile</code> keys, e.g. an empty map, <code>{}</code>.</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> authorization-middleware
|
|
{<span class="hljs-symbol">:name</span> <span class="hljs-symbol">::authorization</span>
|
|
<span class="hljs-symbol">:spec</span> (<span class="hljs-name">s/keys</span> <span class="hljs-symbol">:req-un</span> [<span class="hljs-symbol">::authorize</span>])
|
|
<span class="hljs-symbol">:compile</span>
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [route-data _opts]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">if-let</span></span> [rule (<span class="hljs-symbol">:authorize</span> route-data)]
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [handler]
|
|
(<span class="hljs-name">accessrules/wrap-access-rules</span> handler {<span class="hljs-symbol">:rules</span> [rule]}))
|
|
<span class="hljs-comment">;; return empty map just to enforce spec</span>
|
|
{}))})
|
|
</code></pre>
|
|
<p>The middleware (and associated spec) will still be part of the chain, but will not process the request.</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="route_data_validation.html" class="navigation navigation-prev " aria-label="Previous page: Route Data Validation">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="swagger.html" class="navigation navigation-next " aria-label="Next page: Swagger Support">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Compiling Middleware","level":"4.15","depth":1,"next":{"title":"Swagger Support","level":"4.16","depth":1,"path":"ring/swagger.md","ref":"ring/swagger.md","articles":[]},"previous":{"title":"Route Data Validation","level":"4.14","depth":1,"path":"ring/route_data_validation.md","ref":"ring/route_data_validation.md","articles":[]},"dir":"ltr"},"config":{"plugins":["hints","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":{"github":{"url":"https://github.com/metosin/reitit"},"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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/compiling_middleware.md","mtime":"2020-04-27T12:12:07.558Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-04-27T12:13:29.498Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</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>
|
|
|