luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-20 09:31:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
reitit/basics/route_conflicts.html

548 lines
16 KiB
HTML
Raw Normal View History

Build book from commit 095dfb6724418592ff0695f3ca7ac98f2fd4df61 [skip ci]
2017-10-31 08:26:41 +00:00
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Route conflicts · 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="../advanced/" />
<link rel="prev" href="route_data.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 " data-level="1.2.5" data-path="route_data.html">
<a href="route_data.html">
Route data
</a>
</li>
<li class="chapter active" data-level="1.2.6" 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="../advanced/">
<a href="../advanced/">
Advanced
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../advanced/route_validation.html">
<a href="../advanced/route_validation.html">
Route Validation
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="../advanced/different_routers.html">
<a href="../advanced/different_routers.html">
Different Routers
</a>
</li>
<li class="chapter " data-level="1.3.3" data-path="../advanced/configuring_routers.html">
<a href="../advanced/configuring_routers.html">
Configuring routers
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../ring/">
<a href="../ring/">
Ring
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../ring/ring.html">
<a href="../ring/ring.html">
Ring-router
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="../ring/dynamic_extensions.html">
<a href="../ring/dynamic_extensions.html">
Dynamic extensions
</a>
</li>
<li class="chapter " data-level="1.4.3" 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.4.4" data-path="../ring/parameter_coercion.html">
<a href="../ring/parameter_coercion.html">
Parameter coercion
</a>
</li>
<li class="chapter " data-level="1.4.5" data-path="../ring/compiling_middleware.html">
<a href="../ring/compiling_middleware.html">
Compiling middleware
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" >
<span>
TODO: Swagger & OpenAPI
</span>
</li>
<li class="chapter " data-level="1.6" >
<span>
TODO: Interceptors
</span>
</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 conflicts</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-conflicts">Route conflicts</h1>
<p>Many routing libraries allow multiple matches for a single path lookup. Usually, the first match is used and the rest are effecively unreachanle. This is not good, especially if route tree is merged from multiple sources.</p>
<p>Reitit resolves this by running explicit conflicit resolution when a <code>router</code> is called. Conflicting routes are passed into a <code>:conflicts</code> callback. Default implementation throws <code>ex-info</code> with a descriptive message.</p>
<p>Examples router with conflicting routes:</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> routes
[[<span class="hljs-string">&quot;/ping&quot;</span>]
[<span class="hljs-string">&quot;/:user-id/orders&quot;</span>]
[<span class="hljs-string">&quot;/bulk/:bulk-id&quot;</span>]
[<span class="hljs-string">&quot;/public/*path&quot;</span>]
[<span class="hljs-string">&quot;/:version/status&quot;</span>]])
</code></pre>
<p>By default, <code>ExceptionInfo</code> is thrown:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/router</span> routes)
<span class="hljs-comment">; CompilerException clojure.lang.ExceptionInfo: Router contains conflicting routes:</span>
<span class="hljs-comment">;</span>
<span class="hljs-comment">; /:user-id/orders</span>
<span class="hljs-comment">; -&gt; /public/*path</span>
<span class="hljs-comment">; -&gt; /bulk/:bulk-id</span>
<span class="hljs-comment">;</span>
<span class="hljs-comment">; /bulk/:bulk-id</span>
<span class="hljs-comment">; -&gt; /:version/status</span>
<span class="hljs-comment">;</span>
<span class="hljs-comment">; /public/*path</span>
<span class="hljs-comment">; -&gt; /:version/status</span>
<span class="hljs-comment">;</span>
</code></pre>
<p>Just logging the conflicts:</p>
<pre><code class="lang-clj">(<span class="hljs-name">r/router</span>
routes
{<span class="hljs-symbol">:conflicts</span> (<span class="hljs-name"><span class="hljs-builtin-name">comp</span></span> println reitit/conflicts-str)})
<span class="hljs-comment">; Router contains conflicting routes:</span>
<span class="hljs-comment">;</span>
<span class="hljs-comment">; /:user-id/orders</span>
<span class="hljs-comment">; -&gt; /public/*path</span>
<span class="hljs-comment">; -&gt; /bulk/:bulk-id</span>
<span class="hljs-comment">;</span>
<span class="hljs-comment">; /bulk/:bulk-id</span>
<span class="hljs-comment">; -&gt; /:version/status</span>
<span class="hljs-comment">;</span>
<span class="hljs-comment">; /public/*path</span>
<span class="hljs-comment">; -&gt; /:version/status</span>
<span class="hljs-comment">;</span>
</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>
<a href="route_data.html" class="navigation navigation-prev " aria-label="Previous page: Route data">
<i class="fa fa-angle-left"></i>
</a>
<a href="../advanced/" class="navigation navigation-next " aria-label="Next page: Advanced">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Route conflicts","level":"1.2.6","depth":2,"next":{"title":"Advanced","level":"1.3","depth":1,"path":"advanced/README.md","ref":"advanced/README.md","articles":[{"title":"Route Validation","level":"1.3.1","depth":2,"path":"advanced/route_validation.md","ref":"advanced/route_validation.md","articles":[]},{"title":"Different Routers","level":"1.3.2","depth":2,"path":"advanced/different_routers.md","ref":"advanced/different_routers.md","articles":[]},{"title":"Configuring routers","level":"1.3.3","depth":2,"path":"advanced/configuring_routers.md","ref":"advanced/configuring_routers.md","articles":[]}]},"previous":{"title":"Route data","level":"1.2.5","depth":2,"path":"basics/route_data.md","ref":"basics/route_data.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_conflicts.md","mtime":"2017-10-31T08:26:00.331Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2017-10-31T08:26:38.332Z"},"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>
Reference in a new issue Copy permalink