reitit/basics/router.html

960 lines
26 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Router · 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="path_based_routing.html" />
<link rel="prev" href="route_syntax.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="route_syntax.html">
<a href="route_syntax.html">
Route Syntax
</a>
</li>
<li class="chapter active" data-level="2.2" data-path="router.html">
<a href="router.html">
Router
</a>
</li>
<li class="chapter " data-level="2.3" data-path="path_based_routing.html">
<a href="path_based_routing.html">
Path-based Routing
</a>
</li>
<li class="chapter " data-level="2.4" data-path="name_based_routing.html">
<a href="name_based_routing.html">
Name-based Routing
</a>
</li>
<li class="chapter " data-level="2.5" data-path="route_data.html">
<a href="route_data.html">
Route Data
</a>
</li>
<li class="chapter " data-level="2.6" data-path="route_data_validation.html">
<a href="route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="2.7" data-path="route_conflicts.html">
<a href="route_conflicts.html">
Route Conflicts
</a>
</li>
<li class="chapter " data-level="2.8" data-path="error_messages.html">
<a href="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/ring.html">
<a href="../ring/ring.html">
Ring-router
</a>
</li>
<li class="chapter " data-level="4.2" data-path="../ring/reverse_routing.html">
<a href="../ring/reverse_routing.html">
Reverse-routing
</a>
</li>
<li class="chapter " data-level="4.3" data-path="../ring/default_handler.html">
<a href="../ring/default_handler.html">
Default handler
</a>
</li>
<li class="chapter " data-level="4.4" data-path="../ring/slash_handler.html">
<a href="../ring/slash_handler.html">
Slash handler
</a>
</li>
<li class="chapter " data-level="4.5" data-path="../ring/static.html">
<a href="../ring/static.html">
Static Resources
</a>
</li>
<li class="chapter " data-level="4.6" data-path="../ring/dynamic_extensions.html">
<a href="../ring/dynamic_extensions.html">
Dynamic Extensions
</a>
</li>
<li class="chapter " data-level="4.7" data-path="../ring/data_driven_middleware.html">
<a href="../ring/data_driven_middleware.html">
Data-driven Middleware
</a>
</li>
<li class="chapter " data-level="4.8" data-path="../ring/transforming_middleware_chain.html">
<a href="../ring/transforming_middleware_chain.html">
Transforming Middleware Chain
</a>
</li>
<li class="chapter " data-level="4.9" data-path="../ring/middleware_registry.html">
<a href="../ring/middleware_registry.html">
Middleware Registry
</a>
</li>
<li class="chapter " data-level="4.10" data-path="../ring/default_middleware.html">
<a href="../ring/default_middleware.html">
Default Middleware
</a>
</li>
<li class="chapter " data-level="4.11" data-path="../ring/content_negotiation.html">
<a href="../ring/content_negotiation.html">
Content Negotiation
</a>
</li>
<li class="chapter " data-level="4.12" data-path="../ring/coercion.html">
<a href="../ring/coercion.html">
Ring Coercion
</a>
</li>
<li class="chapter " data-level="4.13" data-path="../ring/route_data_validation.html">
<a href="../ring/route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="4.14" data-path="../ring/compiling_middleware.html">
<a href="../ring/compiling_middleware.html">
Compiling Middleware
</a>
</li>
<li class="chapter " data-level="4.15" data-path="../ring/swagger.html">
<a href="../ring/swagger.html">
Swagger Support
</a>
</li>
<li class="chapter " data-level="4.16" data-path="../ring/RESTful_form_methods.html">
<a href="../ring/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=".." >Router</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="router">Router</h1>
<p>Routes are just data and to do routing, we need a router instance satisfying the <code>reitit.core/Router</code> protocol. Routers are created with <code>reitit.core/router</code> function, taking the raw routes and optionally an options map.</p>
<p>The <code>Router</code> protocol:</p>
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">defprotocol</span></span> Router
(<span class="hljs-name">router-name</span> [this])
(<span class="hljs-name">routes</span> [this])
(<span class="hljs-name">options</span> [this])
(<span class="hljs-name">route-names</span> [this])
(<span class="hljs-name">match-by-path</span> [this path])
(<span class="hljs-name">match-by-name</span> [this name] [this name params]))
</code></pre>
<p>Creating a router:</p>
<pre><code class="lang-clj">(<span class="hljs-name">require</span> &apos;[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">&quot;/api&quot;</span>
[<span class="hljs-string">&quot;/ping&quot;</span> <span class="hljs-symbol">::ping</span>]
[<span class="hljs-string">&quot;/user/:id&quot;</span> <span class="hljs-symbol">::user</span>]]))
</code></pre>
<p>Name of the created router:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/router-name</span> router)
<span class="hljs-comment">; :mixed-router</span>
</code></pre>
<p>The flattened route tree:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/routes</span> router)
<span class="hljs-comment">; [[&quot;/api/ping&quot; {:name :user/ping}]</span>
<span class="hljs-comment">; [&quot;/api/user/:id&quot; {:name :user/user}]]</span>
</code></pre>
<p>With a router instance, we can do <a href="path_based_routing.html">Path-based routing</a> or <a href="name_based_routing.html">Name-based (Reverse) routing</a>.</p>
<h2 id="more-details">More details</h2>
<p>Router options:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/options</span> router)
{<span class="hljs-symbol">:lookup</span> #object[...]
<span class="hljs-symbol">:expand</span> #object[...]
<span class="hljs-symbol">:coerce</span> #object[...]
<span class="hljs-symbol">:compile</span> #object[...]
<span class="hljs-symbol">:conflicts</span> #object[...]}
</code></pre>
<p>Route names:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/route-names</span> router)
<span class="hljs-comment">; [:user/ping :user/user]</span>
</code></pre>
<p>The compiled route tree:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/routes</span> router)
<span class="hljs-comment">; [[&quot;/api/ping&quot; {:name :user/ping} nil]</span>
<span class="hljs-comment">; [&quot;/api/user/:id&quot; {:name :user/user} nil]]</span>
</code></pre>
<h3 id="composing">Composing</h3>
<p>As routes are defined as plain data, it&apos;s easy to merge multiple route trees into a single router</p>
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> user-routes
[[<span class="hljs-string">&quot;/users&quot;</span> <span class="hljs-symbol">::users</span>]
[<span class="hljs-string">&quot;/users/:id&quot;</span> <span class="hljs-symbol">::user</span>]])
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> admin-routes
[<span class="hljs-string">&quot;/admin&quot;</span>
[<span class="hljs-string">&quot;/ping&quot;</span> <span class="hljs-symbol">::ping</span>]
[<span class="hljs-string">&quot;/users&quot;</span> <span class="hljs-symbol">::users</span>]])
(<span class="hljs-name">r/router</span>
[admin-routes
user-routes])
</code></pre>
<p>Merged route tree:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/routes</span> router)
<span class="hljs-comment">; [[&quot;/admin/ping&quot; {:name :user/ping}]</span>
<span class="hljs-comment">; [&quot;/admin/db&quot; {:name :user/db}]</span>
<span class="hljs-comment">; [&quot;/users&quot; {:name :user/users}]</span>
<span class="hljs-comment">; [&quot;/users/:id&quot; {:name :user/user}]]</span>
</code></pre>
<p>More details on <a href="../advanced/composing_routers.html">composing routers</a>.</p>
<h3 id="behind-the-scenes">Behind the scenes</h3>
<p>When router is created, the following steps are done:</p>
<ul>
<li>route tree is flattened</li>
<li>route arguments are expanded (via <code>:expand</code> option)</li>
<li>routes are coerced (via <code>:coerce</code> options)</li>
<li>route tree is compiled (via <code>:compile</code> options)</li>
<li><a href="advanced/route_conflicts.md">route conflicts</a> are resolved (via <code>:conflicts</code> options)</li>
<li>optionally, route data is validated (via <code>:validate</code> options)</li>
<li><a href="../advanced/different_routers.html">router implementation</a> is automatically selected (or forced via <code>:router</code> options) and created</li>
</ul>
</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_syntax.html" class="navigation navigation-prev " aria-label="Previous page: Route Syntax">
<i class="fa fa-angle-left"></i>
</a>
<a href="path_based_routing.html" class="navigation navigation-next " aria-label="Next page: Path-based Routing">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Router","level":"2.2","depth":1,"next":{"title":"Path-based Routing","level":"2.3","depth":1,"path":"basics/path_based_routing.md","ref":"basics/path_based_routing.md","articles":[]},"previous":{"title":"Route Syntax","level":"2.1","depth":1,"path":"basics/route_syntax.md","ref":"basics/route_syntax.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":"basics/router.md","mtime":"2020-03-04T18:55:44.555Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-03-04T18:56:17.209Z"},"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>