mirror of
https://github.com/metosin/reitit.git
synced 2025-12-20 09:31:11 +00:00
746 lines
23 KiB
HTML
746 lines
23 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Route Data · 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="route_data_validation.html" />
|
|
|
|
|
|
<link rel="prev" href="name_based_routing.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="./">
|
|
|
|
<a href="./">
|
|
|
|
|
|
Basics
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.2.1" data-path="route_syntax.html">
|
|
|
|
<a href="route_syntax.html">
|
|
|
|
|
|
Route Syntax
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.2" data-path="router.html">
|
|
|
|
<a href="router.html">
|
|
|
|
|
|
Router
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.3" data-path="path_based_routing.html">
|
|
|
|
<a href="path_based_routing.html">
|
|
|
|
|
|
Path-based Routing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.4" data-path="name_based_routing.html">
|
|
|
|
<a href="name_based_routing.html">
|
|
|
|
|
|
Name-based Routing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="1.2.5" data-path="route_data.html">
|
|
|
|
<a href="route_data.html">
|
|
|
|
|
|
Route Data
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.6" data-path="route_data_validation.html">
|
|
|
|
<a href="route_data_validation.html">
|
|
|
|
|
|
Route Data Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.7" data-path="route_conflicts.html">
|
|
|
|
<a href="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/different_routers.html">
|
|
|
|
<a href="../advanced/different_routers.html">
|
|
|
|
|
|
Different Routers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.3" data-path="../advanced/route_validation.html">
|
|
|
|
<a href="../advanced/route_validation.html">
|
|
|
|
|
|
Route Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4" 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="../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>
|
|
|
|
<li class="chapter " data-level="1.5.2" data-path="../ring/default_handler.html">
|
|
|
|
<a href="../ring/default_handler.html">
|
|
|
|
|
|
Default handler
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.3" data-path="../ring/static.html">
|
|
|
|
<a href="../ring/static.html">
|
|
|
|
|
|
Static Resources
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.4" data-path="../ring/dynamic_extensions.html">
|
|
|
|
<a href="../ring/dynamic_extensions.html">
|
|
|
|
|
|
Dynamic Extensions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.5" data-path="../ring/data_driven_middleware.html">
|
|
|
|
<a href="../ring/data_driven_middleware.html">
|
|
|
|
|
|
Data-driven Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.6" data-path="../ring/coercion.html">
|
|
|
|
<a href="../ring/coercion.html">
|
|
|
|
|
|
Pluggable Coercion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.7" data-path="../ring/route_data_validation.html">
|
|
|
|
<a href="../ring/route_data_validation.html">
|
|
|
|
|
|
Route Data Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.8" data-path="../ring/compiling_middleware.html">
|
|
|
|
<a href="../ring/compiling_middleware.html">
|
|
|
|
|
|
Compiling Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.9" data-path="../ring/swagger.html">
|
|
|
|
<a href="../ring/swagger.html">
|
|
|
|
|
|
Swagger Support
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6" data-path="../performance.html">
|
|
|
|
<a href="../performance.html">
|
|
|
|
|
|
Performance
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.7" data-path="../interceptors.html">
|
|
|
|
<a href="../interceptors.html">
|
|
|
|
|
|
Interceptors (WIP)
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.8" data-path="../development.html">
|
|
|
|
<a href="../development.html">
|
|
|
|
|
|
Development Instructions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.9" 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=".." >Route Data</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="route-data">Route Data</h1>
|
|
<p>Route data is the core feature of reitit. Routes can have any map-like data attachted to them. This data is interpeted either by the client application or the <code>Router</code> via it's <code>:coerce</code> and <code>:compile</code> hooks. Route data format can be defined and validated with <code>clojure.spec</code> enabling a architecture of both <a href="https://youtu.be/x9pxbnFC4aQ?t=1907" target="_blank">adaptive and principled</a> components.</p>
|
|
<p>Raw routes can have a non-sequential route argument that is expanded (via router <code>:expand</code> hook) into route data at router creation time. By default, Keywords are expanded into <code>:name</code> and functions into <code>:handler</code> keys.</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">require</span> '[reitit.core <span class="hljs-symbol">:as</span> r])
|
|
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> router
|
|
(<span class="hljs-name">r/router</span>
|
|
[[<span class="hljs-string">"/ping"</span> <span class="hljs-symbol">::ping</span>]
|
|
[<span class="hljs-string">"/pong"</span> identity]
|
|
[<span class="hljs-string">"/users"</span> {<span class="hljs-symbol">:get</span> {<span class="hljs-symbol">:roles</span> #{<span class="hljs-symbol">:admin</span>}
|
|
<span class="hljs-symbol">:handler</span> identity}}]]))
|
|
</code></pre>
|
|
<p>The expanded route data can be retrieved from a router with <code>routes</code> and is returned with <code>match-by-path</code> and <code>match-by-name</code> in case of a route match.</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">r/routes</span> router)
|
|
<span class="hljs-comment">; [["/ping" {:name :user/ping}]</span>
|
|
<span class="hljs-comment">; ["/pong" {:handler identity]}</span>
|
|
<span class="hljs-comment">; ["/users" {:get {:roles #{:admin}</span>
|
|
<span class="hljs-comment">; :handler identity}}]]</span>
|
|
</code></pre>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">r/match-by-path</span> router <span class="hljs-string">"/ping"</span>)
|
|
<span class="hljs-comment">; #Match{:template "/ping"</span>
|
|
<span class="hljs-comment">; :data {:name :user/ping}</span>
|
|
<span class="hljs-comment">; :result nil</span>
|
|
<span class="hljs-comment">; :path-params {}</span>
|
|
<span class="hljs-comment">; :path "/ping"}</span>
|
|
</code></pre>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">r/match-by-name</span> router <span class="hljs-symbol">::ping</span>)
|
|
<span class="hljs-comment">; #Match{:template "/ping"</span>
|
|
<span class="hljs-comment">; :data {:name :user/ping}</span>
|
|
<span class="hljs-comment">; :result nil</span>
|
|
<span class="hljs-comment">; :path-params {}</span>
|
|
<span class="hljs-comment">; :path "/ping"}</span>
|
|
</code></pre>
|
|
<h2 id="nested-route-data">Nested route data</h2>
|
|
<p>For nested route trees, route data is accumulated recursively from root towards leafs using <a href="https://github.com/weavejester/meta-merge" target="_blank">meta-merge</a>. Default behavior for colections is <code>:append</code>, but this can be overridden to <code>:prepend</code>, <code>:replace</code> or <code>:displace</code> using the target meta-data.</p>
|
|
<p>An example router with nested data:</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> router
|
|
(<span class="hljs-name">r/router</span>
|
|
[<span class="hljs-string">"/api"</span> {<span class="hljs-symbol">:interceptors</span> [<span class="hljs-symbol">::api</span>]}
|
|
[<span class="hljs-string">"/ping"</span> <span class="hljs-symbol">::ping</span>]
|
|
[<span class="hljs-string">"/admin"</span> {<span class="hljs-symbol">:roles</span> #{<span class="hljs-symbol">:admin</span>}}
|
|
[<span class="hljs-string">"/users"</span> <span class="hljs-symbol">::users</span>]
|
|
[<span class="hljs-string">"/db"</span> {<span class="hljs-symbol">:interceptors</span> [<span class="hljs-symbol">::db</span>]
|
|
<span class="hljs-symbol">:roles</span> ^<span class="hljs-symbol">:replace</span> #{<span class="hljs-symbol">:db-admin</span>}}]]]))
|
|
</code></pre>
|
|
<p>Resolved route tree:</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">r/routes</span> router)
|
|
<span class="hljs-comment">; [["/api/ping" {:interceptors [::api]</span>
|
|
<span class="hljs-comment">; :name :user/ping}]</span>
|
|
<span class="hljs-comment">; ["/api/admin/users" {:interceptors [::api]</span>
|
|
<span class="hljs-comment">; :roles #{:admin}</span>
|
|
<span class="hljs-comment">; :name ::users} nil]</span>
|
|
<span class="hljs-comment">; ["/api/admin/db" {:interceptors [::api ::db]</span>
|
|
<span class="hljs-comment">; :roles #{:db-admin}}]]</span>
|
|
</code></pre>
|
|
<h2 id="expansion">Expansion</h2>
|
|
<p>By default, router <code>:expand</code> hook maps to <code>reitit.core/expand</code> function, backed by a <code>reitit.core/Expand</code> protocol. One can provide either a totally different function or add new implementations to that protocol. Expand implementations can be recursive.</p>
|
|
<p>Naive example to add direct support for <code>java.io.File</code> route argument:</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">extend-type</span></span> java.io.File
|
|
r/Expand
|
|
(<span class="hljs-name">expand</span> [file options]
|
|
(<span class="hljs-name">r/expand</span>
|
|
#(<span class="hljs-name"><span class="hljs-builtin-name">slurp</span></span> file)
|
|
options)))
|
|
|
|
(<span class="hljs-name">r/router</span>
|
|
[<span class="hljs-string">"/"</span> (<span class="hljs-name">java.io.File.</span> <span class="hljs-string">"index.html"</span>)])
|
|
</code></pre>
|
|
<p>See <a href="../advanced/configuring_routers.html">router options</a> for all available options.</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="name_based_routing.html" class="navigation navigation-prev " aria-label="Previous page: Name-based Routing">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="route_data_validation.html" class="navigation navigation-next " aria-label="Next page: Route Data Validation">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Route Data","level":"1.2.5","depth":2,"next":{"title":"Route Data Validation","level":"1.2.6","depth":2,"path":"basics/route_data_validation.md","ref":"basics/route_data_validation.md","articles":[]},"previous":{"title":"Name-based Routing","level":"1.2.4","depth":2,"path":"basics/name_based_routing.md","ref":"basics/name_based_routing.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":"basics/route_data.md","mtime":"2018-05-29T05:03:31.882Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-05-29T05:14:24.480Z"},"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>
|
|
|