2017-09-14 13:55:39 +00:00
|
|
|
|
|
|
|
|
<!DOCTYPE HTML>
|
|
|
|
|
<html lang="" >
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
|
|
|
<title>Introduction · 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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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 active" data-level="1.1" data-path="./">
|
|
|
|
|
|
|
|
|
|
<a href="./">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Introduction
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.2" >
|
|
|
|
|
|
|
|
|
|
<span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Routing
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.2.1" data-path="routing/route_syntax.html">
|
|
|
|
|
|
|
|
|
|
<a href="routing/route_syntax.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Route syntax
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.2.2" data-path="routing/routers.html">
|
|
|
|
|
|
|
|
|
|
<a href="routing/routers.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Routers
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.2.3" data-path="routing/route_metadata.html">
|
|
|
|
|
|
|
|
|
|
<a href="routing/route_metadata.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Route metadata
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.2.4" data-path="routing/route_conflicts.html">
|
|
|
|
|
|
|
|
|
|
<a href="routing/route_conflicts.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Route conflicts
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.3" data-path="ring.html">
|
|
|
|
|
|
|
|
|
|
<a href="ring.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ring support
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.4" data-path="parameter_coercion.html">
|
|
|
|
|
|
|
|
|
|
<a href="parameter_coercion.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Parameter coercion
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.5" data-path="compiling_middleware.html">
|
|
|
|
|
|
|
|
|
|
<a href="compiling_middleware.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Compiling middleware
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.6" data-path="validating.html">
|
|
|
|
|
|
|
|
|
|
<a href="validating.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Validating route-trees
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.7" data-path="configuring_routers.html">
|
|
|
|
|
|
|
|
|
|
<a href="configuring_routers.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Configuring routers
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.8" >
|
|
|
|
|
|
|
|
|
|
<span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TODO: Merging route-trees
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.9" >
|
|
|
|
|
|
|
|
|
|
<span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TODO: Swagger & OpenAPI
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.10" >
|
|
|
|
|
|
|
|
|
|
<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="." >Introduction</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="reitit">reitit</h1>
|
|
|
|
|
<p><a href="https://github.com/metosin/reitit" target="_blank">reitit</a> is a friendly data-driven router for Clojure(Script).</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Simple data-driven <a href="routing/route_syntax.html">route syntax</a></li>
|
|
|
|
|
<li>First-class <a href="routing/route_metadata.html">route meta-data</a></li>
|
|
|
|
|
<li>Generic, not tied to HTTP</li>
|
|
|
|
|
<li><a href="routing/route_conflicts.html">Route conflict resolution</a></li>
|
|
|
|
|
<li><a href="parameter-coercion.md">Pluggable coercion</a> (<a href="https://clojure.org/about/spec" target="_blank">clojure.spec</a>)</li>
|
|
|
|
|
<li>both <a href="ring.html#middleware">Middleware</a> & Interceptors</li>
|
|
|
|
|
<li>Extendable</li>
|
|
|
|
|
<li>Fast</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2 id="latest-version">Latest version</h2>
|
|
|
|
|
<p><a href="http://clojars.org/metosin/reitit" target="_blank"><img src="http://clojars.org/metosin/reitit/latest-version.svg" alt="Clojars Project"></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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
var gitbook = gitbook || [];
|
|
|
|
|
gitbook.push(function() {
|
2017-09-14 14:40:31 +00:00
|
|
|
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Routing","level":"1.2","depth":1,"ref":"","articles":[{"title":"Route syntax","level":"1.2.1","depth":2,"path":"routing/route_syntax.md","ref":"routing/route_syntax.md","articles":[]},{"title":"Routers","level":"1.2.2","depth":2,"path":"routing/routers.md","ref":"routing/routers.md","articles":[]},{"title":"Route metadata","level":"1.2.3","depth":2,"path":"routing/route_metadata.md","ref":"routing/route_metadata.md","articles":[]},{"title":"Route conflicts","level":"1.2.4","depth":2,"path":"routing/route_conflicts.md","ref":"routing/route_conflicts.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":"README.md","mtime":"2017-09-14T14:39:52.093Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2017-09-14T14:40:29.150Z"},"basePath":".","book":{"language":""}});
|
2017-09-14 13:55:39 +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>
|
|
|
|
|
|
