2018-09-03 15:58:24 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > Shared Routes · 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 = "../performance.html" / >
< link rel = "prev" href = "dev_workflow.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 >
2018-10-30 17:54:38 +00:00
< 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" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/static.html" >
Static Resources
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.6" data-path = "../ring/dynamic_extensions.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/dynamic_extensions.html" >
Dynamic Extensions
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.7" data-path = "../ring/data_driven_middleware.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/data_driven_middleware.html" >
Data-driven Middleware
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.8" data-path = "../ring/transforming_middleware_chain.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/transforming_middleware_chain.html" >
Transforming Middleware Chain
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.9" data-path = "../ring/middleware_registry.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/middleware_registry.html" >
Middleware Registry
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.10" data-path = "../ring/default_middleware.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/default_middleware.html" >
Default Middleware
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.11" data-path = "../ring/coercion.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/coercion.html" >
Pluggable Coercion
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.12" data-path = "../ring/route_data_validation.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.13" data-path = "../ring/compiling_middleware.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/compiling_middleware.html" >
Compiling Middleware
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.14" data-path = "../ring/swagger.html" >
2018-09-03 15:58:24 +00:00
< a href = "../ring/swagger.html" >
Swagger Support
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "header" > HTTP< / li >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.1" data-path = "../http/interceptors.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/interceptors.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
Interceptors
2018-09-03 15:58:24 +00:00
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.2" data-path = "../http/pedestal.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/pedestal.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
Pedestal
2018-09-03 15:58:24 +00:00
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.3" data-path = "../http/sieppari.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< 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" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
Default Interceptors
2018-09-03 15:58:24 +00:00
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "header" > Frontend< / li >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "6.1" data-path = "../frontend/basics.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../frontend/basics.html" >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
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
2018-09-03 15:58:24 +00:00
< / a >
< / li >
< li class = "header" > Advanced< / li >
< li class = "chapter " data-level = "7.1" data-path = "configuring_routers.html" >
< a href = "configuring_routers.html" >
Configuring Routers
< / a >
< / li >
< li class = "chapter " data-level = "7.2" data-path = "composing_routers.html" >
< a href = "composing_routers.html" >
Composing Routers
< / a >
< / li >
< li class = "chapter " data-level = "7.3" data-path = "different_routers.html" >
< a href = "different_routers.html" >
Different Routers
< / a >
< / li >
< li class = "chapter " data-level = "7.4" data-path = "route_validation.html" >
< a href = "route_validation.html" >
Route Validation
< / a >
< / li >
< li class = "chapter " data-level = "7.5" data-path = "dev_workflow.html" >
< a href = "dev_workflow.html" >
Dev Workflow
< / a >
< / li >
< li class = "chapter active" data-level = "7.6" data-path = "shared_routes.html" >
< a href = "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 = ".." > Shared Routes< / 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 = "shared-routes" > Shared routes< / h1 >
2018-10-15 09:14:39 +00:00
< p > As < code > reitit-core< / code > works with both Clojure & ClojureScript, one can have a shared routing table for both the frontend and the backend application, using the < a href = "https://clojure.org/guides/reader_conditionals" target = "_blank" > Clojure Common Files< / a > .< / p >
2018-09-03 15:58:24 +00:00
< p > For backend, you need to define a < code > :handler< / code > for the request processing, for fronend, < code > :name< / code > enables the use of < a href = "../basics/name_based_routing.html" > reverse routing< / a > .< / p >
< p > There are multiple options to use shared routing table.< / p >
< h2 id = "using-reader-conditionals" > Using reader conditionals< / h2 >
< pre > < code class = "lang-clj" > ;; define the handlers for for clojure
#?(:clj (declare get-kikka))
#?(:clj (declare post-kikka))
;; :name for both, :handler just for clojure
(def routes
[" /kikka"
{:name ::kikka
2018-10-05 10:38:35 +00:00
#?@(:clj [:get {:handler get-kikka}])
#?@(:clj [:post {:handler post-kikka}])}])
2018-09-03 15:58:24 +00:00
< / code > < / pre >
< h2 id = "using-custom-expander" > Using custom expander< / h2 >
< p > raw-routes can have any non-sequential data as a route argument, which gets expanded using the < code > :expand< / code > option given to the < code > reitit.core.router< / code > function. It defaults to < code > reitit.core/expand< / code > multimethod.< / p >
< p > First, define the common routes (in a < code > .cljc< / code > file):< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > routes
[[< span class = "hljs-string" > " /kikka" < / span > < span class = "hljs-symbol" > ::kikka< / span > ]
[< span class = "hljs-string" > " /bar" < / span > < span class = "hljs-symbol" > ::bar< / span > ]])
< / code > < / pre >
< p > Those can be used as-is from ClojureScript:< / 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 > routes))
(< span class = "hljs-name" > r/match-by-name< / span > router < span class = "hljs-symbol" > ::kikka< / span > )
< span class = "hljs-comment" > ;#Match{:template " /kikka" < / span >
< span class = "hljs-comment" > ; :data {:name :user/kikka}< / span >
< span class = "hljs-comment" > ; :result nil< / span >
< span class = "hljs-comment" > ; :path-params nil< / span >
< span class = "hljs-comment" > ; :path " /kikka" }< / span >
< / code > < / pre >
< p > For the backend, we can use a custom-expander to expand the routes:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring < span class = "hljs-symbol" > :as< / span > ring])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > my-expand [registry]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [data opts]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > or< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > if< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > keyword?< / span > < / span > data)
(< span class = "hljs-name" > some-> < / span > data
registry
(< span class = "hljs-name" > r/expand< / span > opts)
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > assoc< / span > < / span > < span class = "hljs-symbol" > :name< / span > data)))
(< span class = "hljs-name" > r/expand< / span > data opts))))
< span class = "hljs-comment" > ;; the handler functions< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > get-kikka [_] {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " get" < / span > })
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > post-kikka [_] {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " post" < / span > })
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > bar [_] {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " bar" < / span > })
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > app
(< span class = "hljs-name" > ring/ring-handler< / span >
(< span class = "hljs-name" > ring/router< / span >
[[< span class = "hljs-string" > " /kikka" < / span > < span class = "hljs-symbol" > ::kikka< / span > ]
[< span class = "hljs-string" > " /bar" < / span > < span class = "hljs-symbol" > ::bar< / span > ]]
< span class = "hljs-comment" > ;; use a custom expander< / span >
{< span class = "hljs-symbol" > :expand< / span > (< span class = "hljs-name" > my-expand< / span >
{< span class = "hljs-symbol" > ::kikka< / span > {< span class = "hljs-symbol" > :get< / span > get-kikka
< span class = "hljs-symbol" > :post< / span > post-kikka}
< span class = "hljs-symbol" > ::bar< / span > bar})})))
(< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :post< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /kikka" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body " post" }< / 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 = "dev_workflow.html" class = "navigation navigation-prev " aria-label = "Previous page: Dev Workflow" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "../performance.html" class = "navigation navigation-next " aria-label = "Next page: Performance" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-10-31 07:44:47 +00:00
gitbook.page.hasChanged({"page":{"title":"Shared Routes","level":"7.6","depth":1,"next":{"title":"Performance","level":"8.1","depth":1,"path":"performance.md","ref":"performance.md","articles":[]},"previous":{"title":"Dev Workflow","level":"7.5","depth":1,"path":"advanced/dev_workflow.md","ref":"advanced/dev_workflow.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":"advanced/shared_routes.md","mtime":"2018-10-31T07:44:16.939Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-31T07:44:43.235Z"},"basePath":"..","book":{"language":""}});
2018-09-03 15:58:24 +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 >
