reitit/http/pedestal.html
2019-02-08 12:46:12 +00:00

915 lines
27 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Pedestal · 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="sieppari.html" />
<link rel="prev" href="interceptors.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="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/coercion.html">
<a href="../ring/coercion.html">
Pluggable Coercion
</a>
</li>
<li class="chapter " data-level="4.12" 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.13" data-path="../ring/compiling_middleware.html">
<a href="../ring/compiling_middleware.html">
Compiling Middleware
</a>
</li>
<li class="chapter " data-level="4.14" data-path="../ring/swagger.html">
<a href="../ring/swagger.html">
Swagger Support
</a>
</li>
<li class="chapter " data-level="4.15" 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="interceptors.html">
<a href="interceptors.html">
Interceptors
</a>
</li>
<li class="chapter active" data-level="5.2" data-path="pedestal.html">
<a href="pedestal.html">
Pedestal
</a>
</li>
<li class="chapter " data-level="5.3" data-path="sieppari.html">
<a href="sieppari.html">
Sieppari
</a>
</li>
<li class="chapter " data-level="5.4" data-path="default_interceptors.html">
<a href="default_interceptors.html">
Default Interceptors
</a>
</li>
<li class="chapter " data-level="5.5" data-path="transforming_interceptor_chain.html">
<a href="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=".." >Pedestal</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="pedestal">Pedestal</h1>
<p><a href="http://pedestal.io/" target="_blank">Pedestal</a> is a backend web framework for Clojure. <code>reitit-pedestal</code> provides an alternative routing engine for Pedestal.</p>
<pre><code class="lang-clj">[metosin/reitit-pedestal <span class="hljs-string">&quot;0.2.13&quot;</span>]
</code></pre>
<p>Why should one use reitit instead of the Pedestal <a href="http://pedestal.io/reference/routing-quick-reference" target="_blank">default routing</a>?</p>
<ul>
<li>One simple <a href="../basics/route_syntax.html">route syntax</a>, with full <a href="../basics/route_conflicts.html">route conflict resolution</a>.</li>
<li>Supports <a href="../basics/route_data.html">first class route data</a> with <a href="../basics/route_data_validation.html">spec validation</a>.</li>
<li>Fixes some <a href="https://github.com/pedestal/pedestal/issues/532" target="_blank">known problems</a> in routing.</li>
<li>Can handle <a href="../ring/slash_handler.html">trailing backslashes</a>.</li>
<li>One router for both backend and <a href="../frontend/basics.html">frontend</a>.</li>
<li>Supports <a href="../ring/coercion.html">parameter coercion</a> &amp; <a href="../ring/swagger.html">Swagger</a>.</li>
<li>Is even <a href="../performance.html">faster</a>.</li>
</ul>
<p>To use Pedestal with reitit, you should first read both the <a href="http://pedestal.io/" target="_blank">Pedestal docs</a> and the <a href="interceptors.html">reitit interceptor guide</a>.</p>
<h2 id="example">Example</h2>
<p>A minimalistic example on how to to swap the default-router with a reitit router.</p>
<pre><code class="lang-clj"><span class="hljs-comment">; [io.pedestal/pedestal.service &quot;0.5.5&quot;]</span>
<span class="hljs-comment">; [io.pedestal/pedestal.jetty &quot;0.5.5&quot;]</span>
<span class="hljs-comment">; [metosin/reitit-pedestal &quot;0.2.13&quot;]</span>
<span class="hljs-comment">; [metosin/reitit &quot;0.2.13&quot;]</span>
(<span class="hljs-name">require</span> &apos;[io.pedestal.http <span class="hljs-symbol">:as</span> server])
(<span class="hljs-name">require</span> &apos;[reitit.pedestal <span class="hljs-symbol">:as</span> pedestal])
(<span class="hljs-name">require</span> &apos;[reitit.http <span class="hljs-symbol">:as</span> http])
(<span class="hljs-name">require</span> &apos;[reitit.ring <span class="hljs-symbol">:as</span> ring])
(<span class="hljs-name"><span class="hljs-builtin-name">defn</span></span> interceptor [number]
{<span class="hljs-symbol">:enter</span> (<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [ctx] (<span class="hljs-name"><span class="hljs-builtin-name">update-in</span></span> ctx [<span class="hljs-symbol">:request</span> <span class="hljs-symbol">:number</span>] (<span class="hljs-name">fnil</span> + <span class="hljs-number">0</span>) number))})
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> routes
[<span class="hljs-string">&quot;/api&quot;</span>
{<span class="hljs-symbol">:interceptors</span> [(<span class="hljs-name">interceptor</span> <span class="hljs-number">1</span>)]}
[<span class="hljs-string">&quot;/number&quot;</span>
{<span class="hljs-symbol">:interceptors</span> [(<span class="hljs-name">interceptor</span> <span class="hljs-number">10</span>)]
<span class="hljs-symbol">:get</span> {<span class="hljs-symbol">:interceptors</span> [(<span class="hljs-name">interceptor</span> <span class="hljs-number">100</span>)]
<span class="hljs-symbol">:handler</span> (<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [req]
{<span class="hljs-symbol">:status</span> <span class="hljs-number">200</span>
<span class="hljs-symbol">:body</span> (<span class="hljs-name"><span class="hljs-builtin-name">select-keys</span></span> req [<span class="hljs-symbol">:number</span>])})}}]])
(<span class="hljs-name"><span class="hljs-builtin-name">-&gt;</span></span> {<span class="hljs-symbol">::server/type</span> <span class="hljs-symbol">:jetty</span>
<span class="hljs-symbol">::server/port</span> <span class="hljs-number">3000</span>
<span class="hljs-symbol">::server/join?</span> <span class="hljs-literal">false</span>
<span class="hljs-comment">;; no pedestal routes</span>
<span class="hljs-symbol">::server/routes</span> []}
(<span class="hljs-name">server/default-interceptors</span>)
<span class="hljs-comment">;; swap the reitit router</span>
(<span class="hljs-name">pedestal/replace-last-interceptor</span>
(<span class="hljs-name">pedestal/routing-interceptor</span>
(<span class="hljs-name">http/router</span> routes)))
(<span class="hljs-name">server/dev-interceptors</span>)
(<span class="hljs-name">server/create-server</span>)
(<span class="hljs-name">server/start</span>))
</code></pre>
<h2 id="compatibility">Compatibility</h2>
<p>There is no common interceptor spec for Clojure and all default reitit interceptors (coercion, exceptions etc.) use the <a href="https://github.com/metosin/sieppari" target="_blank">Sieppari</a> interceptor model. It is mostly compatible with the Pedestal Interceptor model, only exception being that the <code>:error</code> handlers take just 1 arity (<code>context</code>) compared to <a href="http://pedestal.io/reference/error-handling" target="_blank">Pedestal&apos;s 2-arity</a> (<code>context</code> and <code>exception</code>).</p>
<p>Currently, out of the reitit default interceptors, there is only the <code>reitit.http.interceptors.exception/exception-interceptor</code> which has the <code>:error</code> defined.</p>
<p>You are most welcome to discuss about a common interceptor spec in <a href="https://clojurians.slack.com/messages/interceptors/" target="_blank">#interceptors</a> on <a href="http://clojurians.net/" target="_blank">Clojurians Slack</a>.</p>
<h2 id="more-examples">More examples</h2>
<h3 id="simple">Simple</h3>
<p>Simple example with sync &amp; async interceptors: <a href="https://github.com/metosin/reitit/tree/master/examples/pedestal" target="_blank">https://github.com/metosin/reitit/tree/master/examples/pedestal</a></p>
<h3 id="swagger">Swagger</h3>
<p>More complete example with custom interceptors, <a href="default_interceptors.html">default interceptors</a>, <a href="../coercion/coercion.html">coercion</a> and <a href="../ring/swagger.html">swagger</a>-support enabled: <a href="https://github.com/metosin/reitit/tree/master/examples/pedestal-swagger" target="_blank">https://github.com/metosin/reitit/tree/master/examples/pedestal-swagger</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>
<a href="interceptors.html" class="navigation navigation-prev " aria-label="Previous page: Interceptors">
<i class="fa fa-angle-left"></i>
</a>
<a href="sieppari.html" class="navigation navigation-next " aria-label="Next page: Sieppari">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Pedestal","level":"5.2","depth":1,"next":{"title":"Sieppari","level":"5.3","depth":1,"path":"http/sieppari.md","ref":"http/sieppari.md","articles":[]},"previous":{"title":"Interceptors","level":"5.1","depth":1,"path":"http/interceptors.md","ref":"http/interceptors.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":"http/pedestal.md","mtime":"2019-02-08T12:45:40.808Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-08T12:46:08.177Z"},"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>