2017-10-29 07:30:23 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > Ring-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" >
2018-09-03 15:58:24 +00:00
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-hints/plugin-hints.css" >
2017-10-29 07:30:23 +00:00
< 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" >
2018-06-14 10:29:02 +00:00
< link rel = "next" href = "reverse_routing.html" / >
2017-10-29 07:30:23 +00:00
2018-09-03 15:58:24 +00:00
< link rel = "prev" href = "../coercion/data_spec_coercion.html" / >
2017-10-29 07:30:23 +00:00
< / 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" >
2018-09-03 15:58:24 +00:00
< li class = "header" > Introduction< / li >
2017-10-29 07:30:23 +00:00
< li class = "chapter " data-level = "1.1" data-path = "../" >
< a href = "../" >
Introduction
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Basics< / li >
< li class = "chapter " data-level = "2.1" data-path = "../basics/route_syntax.html" >
2017-10-29 07:30:23 +00:00
< a href = "../basics/route_syntax.html" >
2017-12-10 16:03:30 +00:00
Route Syntax
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.2" data-path = "../basics/router.html" >
2017-10-29 07:30:23 +00:00
< a href = "../basics/router.html" >
Router
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.3" data-path = "../basics/path_based_routing.html" >
2017-10-29 07:30:23 +00:00
< a href = "../basics/path_based_routing.html" >
Path-based Routing
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.4" data-path = "../basics/name_based_routing.html" >
2017-10-29 07:30:23 +00:00
< a href = "../basics/name_based_routing.html" >
Name-based Routing
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.5" data-path = "../basics/route_data.html" >
2017-10-29 07:30:23 +00:00
< a href = "../basics/route_data.html" >
2017-12-10 16:03:30 +00:00
Route Data
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.6" data-path = "../basics/route_data_validation.html" >
2017-12-28 09:00:03 +00:00
< a href = "../basics/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.7" data-path = "../basics/route_conflicts.html" >
2017-10-29 07:30:23 +00:00
2017-10-31 08:26:41 +00:00
< a href = "../basics/route_conflicts.html" >
2017-10-29 07:30:23 +00:00
2017-12-10 16:03:30 +00:00
Route Conflicts
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Coercion< / li >
2017-12-10 16:03:30 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.1" data-path = "../coercion/coercion.html" >
2017-12-10 16:03:30 +00:00
< a href = "../coercion/coercion.html" >
Coercion Explained
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.2" data-path = "../coercion/schema_coercion.html" >
2017-12-10 16:03:30 +00:00
< a href = "../coercion/schema_coercion.html" >
Plumatic Schema
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.3" data-path = "../coercion/clojure_spec_coercion.html" >
2017-12-10 16:03:30 +00:00
< a href = "../coercion/clojure_spec_coercion.html" >
Clojure.spec
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.4" data-path = "../coercion/data_spec_coercion.html" >
2017-12-10 16:03:30 +00:00
< a href = "../coercion/data_spec_coercion.html" >
Data-specs
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Ring< / li >
2017-10-29 07:30:23 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter active" data-level = "4.1" data-path = "ring.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
Ring-router
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.2" data-path = "reverse_routing.html" >
2018-07-18 10:13:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "reverse_routing.html" >
2018-07-18 10:13:28 +00:00
2018-08-25 12:49:36 +00:00
Reverse-routing
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.3" data-path = "default_handler.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
< a href = "default_handler.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
Default handler
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.4" data-path = "slash_handler.html" >
< a href = "slash_handler.html" >
Slash handler
< / a >
< / li >
< li class = "chapter " data-level = "4.5" data-path = "static.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
< a href = "static.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
Static Resources
2017-10-29 07:30:23 +00:00
< / a >
2018-03-15 06:09:15 +00:00
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.6" data-path = "dynamic_extensions.html" >
2018-03-15 06:09:15 +00:00
2018-08-25 12:49:36 +00:00
< a href = "dynamic_extensions.html" >
2018-03-15 06:09:15 +00:00
2018-08-25 12:49:36 +00:00
Dynamic Extensions
2018-03-15 06:09:15 +00:00
< / a >
2017-10-29 07:30:23 +00:00
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.7" data-path = "data_driven_middleware.html" >
2018-08-25 12:49:36 +00:00
< a href = "data_driven_middleware.html" >
Data-driven Middleware
< / a >
2017-10-29 07:30:23 +00:00
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.8" data-path = "transforming_middleware_chain.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
< a href = "transforming_middleware_chain.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
Transforming Middleware Chain
2017-10-29 07:30:23 +00:00
< / a >
2018-08-25 12:49:36 +00:00
< / li >
2017-10-29 07:30:23 +00:00
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.9" data-path = "middleware_registry.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
< a href = "middleware_registry.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
Middleware Registry
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.10" data-path = "default_middleware.html" >
2018-06-14 10:29:02 +00:00
2018-08-25 12:49:36 +00:00
< a href = "default_middleware.html" >
2018-06-14 10:29:02 +00:00
2018-08-25 12:49:36 +00:00
Default Middleware
2018-06-14 10:29:02 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.11" data-path = "coercion.html" >
2018-04-25 18:13:54 +00:00
2018-08-25 12:49:36 +00:00
< a href = "coercion.html" >
2018-04-25 18:13:54 +00:00
2018-08-25 12:49:36 +00:00
Pluggable Coercion
2018-04-25 18:13:54 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.12" data-path = "route_data_validation.html" >
2018-04-25 09:50:40 +00:00
2018-08-25 12:49:36 +00:00
< a href = "route_data_validation.html" >
2018-04-25 09:50:40 +00:00
2018-08-25 12:49:36 +00:00
Route Data Validation
2018-04-25 09:50:40 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.13" data-path = "compiling_middleware.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
< a href = "compiling_middleware.html" >
2017-10-29 07:30:23 +00:00
2018-08-25 12:49:36 +00:00
Compiling Middleware
2017-10-29 07:30:23 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.14" data-path = "swagger.html" >
2017-10-31 08:26:41 +00:00
2018-08-25 12:49:36 +00:00
< a href = "swagger.html" >
2017-10-31 08:26:41 +00:00
2018-08-25 12:49:36 +00:00
Swagger Support
2017-10-31 08:26:41 +00:00
< / a >
< / li >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< li class = "header" > HTTP< / li >
2018-09-03 15:58:24 +00:00
2018-08-22 18:52:18 +00:00
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.1" data-path = "../http/interceptors.html" >
2018-07-28 09:08:17 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/interceptors.html" >
2018-07-28 09:08:17 +00:00
2018-09-08 07:54:15 +00:00
Interceptors
2018-07-28 09:08:17 +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-08-03 07:10:16 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/pedestal.html" >
2018-08-03 07:10:16 +00:00
2018-09-08 07:54:15 +00:00
Pedestal
2018-08-03 07:10:16 +00:00
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.3" data-path = "../http/sieppari.html" >
2017-10-29 07:30:23 +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" >
2017-10-29 07:30:23 +00:00
2018-09-08 07:54:15 +00:00
Default Interceptors
2017-10-29 07:30:23 +00:00
< / a >
2018-12-30 15:16:28 +00:00
< / 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 >
2017-10-29 07:30:23 +00:00
< / li >
2017-12-29 10:06:19 +00:00
2018-09-03 15:58:24 +00:00
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" >
2017-10-29 07:30:23 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../frontend/basics.html" >
2017-10-29 07:30:23 +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
2017-10-29 07:30:23 +00:00
< / a >
2018-05-14 13:54:28 +00:00
< / li >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< li class = "header" > Advanced< / li >
< li class = "chapter " data-level = "7.1" data-path = "../advanced/configuring_routers.html" >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/configuring_routers.html" >
2018-05-14 13:54:28 +00:00
2018-09-03 15:58:24 +00:00
Configuring Routers
2018-08-25 12:49:36 +00:00
< / a >
2018-09-03 15:58:24 +00:00
< / li >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.2" data-path = "../advanced/composing_routers.html" >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/composing_routers.html" >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
Composing Routers
2018-05-14 13:54:28 +00:00
< / a >
2017-10-29 07:30:23 +00:00
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.3" data-path = "../advanced/different_routers.html" >
2017-10-29 07:30:23 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/different_routers.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Different Routers
2018-07-18 10:13:28 +00:00
< / a >
2018-09-03 15:58:24 +00:00
< / li >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.4" data-path = "../advanced/route_validation.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/route_validation.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Route Validation
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.5" data-path = "../advanced/dev_workflow.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/dev_workflow.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Dev Workflow
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.6" data-path = "../advanced/shared_routes.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/shared_routes.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Shared Routes
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Misc< / li >
< li class = "chapter " data-level = "8.1" data-path = "../performance.html" >
2017-11-01 07:29:38 +00:00
2018-02-11 19:36:11 +00:00
< a href = "../performance.html" >
2017-11-01 07:29:38 +00:00
2018-02-11 19:36:11 +00:00
Performance
2017-11-01 07:29:38 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "8.2" data-path = "../development.html" >
2018-05-20 16:52:28 +00:00
< a href = "../development.html" >
Development Instructions
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "8.3" data-path = "../faq.html" >
2018-02-02 12:49:20 +00:00
< a href = "../faq.html" >
FAQ
< / a >
2017-10-29 07:30:23 +00:00
< / 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 = ".." > Ring-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 = "ring-router" > Ring Router< / h1 >
2018-02-11 19:36:11 +00:00
< p > < a href = "https://github.com/ring-clojure/ring" target = "_blank" > Ring< / a > is a Clojure web applications library inspired by Python' s WSGI and Ruby' s Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows web applications to be constructed of modular components that can be shared among a variety of applications, web servers, and web frameworks.< / p >
2018-09-24 17:30:47 +00:00
< p > Read more about the < a href = "https://github.com/ring-clojure/ring/wiki/Concepts" target = "_blank" > Ring Concepts< / a > .< / p >
2018-12-30 15:49:06 +00:00
< pre > < code class = "lang-clj" > [metosin/reitit-ring < span class = "hljs-string" > " 0.2.10" < / span > ]
2018-02-11 19:36:11 +00:00
< / code > < / pre >
2018-09-24 17:30:47 +00:00
< h2 id = "reititringring-router" > < code > reitit.ring/ring-router< / code > < / h2 >
< p > < code > ring-router< / code > is a higher order router, which adds support for < code > :request-method< / code > based routing, < a href = "https://github.com/ring-clojure/ring/wiki/Concepts#handlers" target = "_blank" > handlers< / a > and < a href = "https://github.com/ring-clojure/ring/wiki/Concepts#middleware" target = "_blank" > middleware< / a > .< / p >
< p > It accepts the following options:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > :reitit.middleware/transform< / code > < / td >
< td > Function of < code > [Middleware] => [Middleware]< / code > to transform the expanded Middleware (default: identity).< / td >
< / tr >
< tr >
< td > < code > :reitit.middleware/registry< / code > < / td >
< td > Map of < code > keyword => IntoMiddleware< / code > to replace keyword references into Middleware< / td >
< / tr >
< tr >
< td > < code > :reitit.ring/default-options-handler< / code > < / td >
< td > Default handler for < code > :options< / code > method in endpoints (default: default-options-handler)< / td >
< / tr >
< / tbody >
< / table >
< p > Example router:< / p >
2017-10-29 07:30:23 +00:00
< 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 > handler [_]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " ok" < / span > })
2018-09-24 17:30:47 +00:00
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > router
(< span class = "hljs-name" > ring/router< / span >
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :get< / span > handler}]))
< / code > < / pre >
< p > Match contains < code > :result< / code > compiled by the < code > ring-router< / code > :< / 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" > r/match-by-path< / span > router < span class = "hljs-string" > " /ping" < / span > )
< span class = "hljs-comment" > ;#Match{:template " /ping" < / span >
< span class = "hljs-comment" > ; :data {:get {:handler #object[...]}}< / span >
< span class = "hljs-comment" > ; :result #Methods{:get #Endpoint{...}< / span >
< span class = "hljs-comment" > ; :options #Endpoint{...}}< / span >
< span class = "hljs-comment" > ; :path-params {}< / span >
< span class = "hljs-comment" > ; :path " /ping" }< / span >
< / code > < / pre >
< h2 id = "reititringring-handler" > < code > reitit.ring/ring-handler< / code > < / h2 >
< p > Given a < code > ring-router< / code > , optional default-handler & options, < code > ring-handler< / code > function will return a valid ring handler supporting both synchronous and < a href = "https://www.booleanknot.com/blog/2016/07/15/asynchronous-ring.html" target = "_blank" > asynchronous< / a > request handling. The following options are available:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > :middleware< / code > < / td >
< td > Optional sequence of middleware that wrap the ring-handler" < / td >
< / tr >
2019-01-16 07:37:33 +00:00
< tr >
< td > < code > :inject-match?< / code > < / td >
< td > Boolean to inject < code > match< / code > into request under < code > :reitit.core/match< / code > key (default true)< / td >
< / tr >
< tr >
< td > < code > :inject-router?< / code > < / td >
< td > Boolean to inject < code > router< / code > into request under < code > :reitit.core/router< / code > key (default true)< / td >
< / tr >
2018-09-24 17:30:47 +00:00
< / tbody >
< / table >
< p > Simple Ring app:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > app (< span class = "hljs-name" > ring/ring-handler< / span > router))
2017-10-29 07:30:23 +00:00
< / code > < / pre >
< p > Applying the handler:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /favicon.ico" < / span > })
< span class = "hljs-comment" > ; nil< / span >
2018-02-11 19:36:11 +00:00
< / code > < / pre >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /ping" < / span > })
2017-10-29 07:30:23 +00:00
< span class = "hljs-comment" > ; {:status 200, :body " ok" }< / span >
< / code > < / pre >
2018-09-24 17:30:47 +00:00
< p > The router can be accessed via < code > get-router< / code > :< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > app (< span class = "hljs-name" > ring/get-router< / span > ) (< span class = "hljs-name" > r/compiled-routes< / span > ))
< span class = "hljs-comment" > ;[[" /ping" < / span >
< span class = "hljs-comment" > ; {:handler #object[...]}< / span >
< span class = "hljs-comment" > ; #Methods{:get #Endpoint{:data {:handler #object[...]}< / span >
< span class = "hljs-comment" > ; :handler #object[...]< / span >
< span class = "hljs-comment" > ; :middleware []}< / span >
< span class = "hljs-comment" > ; :options #Endpoint{:data {:handler #object[...]}< / span >
< span class = "hljs-comment" > ; :handler #object[...]< / span >
< span class = "hljs-comment" > ; :middleware []}}]]< / span >
2017-10-29 07:30:23 +00:00
< / code > < / pre >
< h1 id = "request-method-based-routing" > Request-method based routing< / h1 >
2018-09-24 17:30:47 +00:00
< p > Handlers can be placed either to the top-level (all methods) or under a specific method (< code > :get< / code > , < code > :head< / code > , < code > :patch< / code > , < code > :delete< / code > , < code > :options< / code > , < code > :post< / code > , < code > :put< / code > or < code > :trace< / code > ). Top-level handler is used if request-method based handler is not found. < / p >
< p > By default, the < code > :options< / code > route is generated for all paths - to enable thing like < a href = "https://en.wikipedia.org/wiki/Cross-origin_resource_sharing" target = "_blank" > CORS< / a > .< / p >
2017-10-29 07:30:23 +00:00
< pre > < code class = "lang-clj" > (< 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 >
2018-09-24 17:30:47 +00:00
[[< span class = "hljs-string" > " /all" < / span > handler]
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::ping< / span >
< span class = "hljs-symbol" > :get< / span > handler
< span class = "hljs-symbol" > :post< / span > handler}]])))
< / code > < / pre >
< p > Top-level handler catches all methods:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :delete< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /all" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body " ok" }< / span >
< / code > < / pre >
< p > Method-level handler catches only the method:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /ping" < / span > })
2017-10-29 07:30:23 +00:00
< span class = "hljs-comment" > ; {:status 200, :body " ok" }< / span >
(< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :put< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /ping" < / span > })
< span class = "hljs-comment" > ; nil< / span >
< / code > < / pre >
2018-09-24 17:30:47 +00:00
< p > By default, < code > :options< / code > is also supported (see router options to change this):< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :options< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /ping" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body " " }< / span >
< / code > < / pre >
2017-10-31 08:26:41 +00:00
< p > Name-based reverse routing:< / p >
2017-10-29 07:30:23 +00:00
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > app
(< span class = "hljs-name" > ring/get-router< / span > )
2018-09-24 17:30:47 +00:00
(< span class = "hljs-name" > r/match-by-name< / span > < span class = "hljs-symbol" > ::ping< / span > )
(< span class = "hljs-name" > r/match-> path< / span > ))
2017-10-29 07:30:23 +00:00
< span class = "hljs-comment" > ; " /ping" < / span >
< / code > < / pre >
< h1 id = "middleware" > Middleware< / h1 >
2018-09-24 17:30:47 +00:00
< p > Middleware can be mounted using a < code > :middleware< / code > key - either to top-level or under request method submap. Its value should be a vector of < code > reitit.middleware/IntoMiddleware< / code > values. These include:< / p >
2017-10-29 07:30:23 +00:00
< ol >
2017-10-31 08:26:41 +00:00
< li > normal ring middleware function < code > handler -> request -> response< / code > < / li >
2018-07-28 09:08:17 +00:00
< li > vector of middleware function < code > [handler args*] -> request -> response< / code > and it' s arguments< / li >
< li > a < a href = "data_driven_middleware.html" > data-driven middleware< / a > record or a map< / li >
< li > a Keyword name, to lookup the middleware from a < a href = "middleware_registry.html" > Middleware Registry< / a > < / li >
2017-10-29 07:30:23 +00:00
< / ol >
< p > A middleware and a handler:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > wrap [handler id]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [request]
(< span class = "hljs-name" > handler< / span > (< span class = "hljs-name" > update< / span > request < span class = "hljs-symbol" > ::acc< / span > (< span class = "hljs-name" > fnil< / span > conj []) id))))
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > handler [{< span class = "hljs-symbol" > :keys< / span > [< span class = "hljs-symbol" > ::acc< / span > ]}]
{< 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" > conj< / span > < / span > acc < span class = "hljs-symbol" > :handler< / span > )})
< / code > < / pre >
< p > App with nested middleware:< / p >
< pre > < code class = "lang-clj" > (< 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 >
2018-02-11 19:36:11 +00:00
< span class = "hljs-comment" > ;; a middleware function< / span >
2017-10-29 07:30:23 +00:00
[< span class = "hljs-string" > " /api" < / span > {< span class = "hljs-symbol" > :middleware< / span > [#(< span class = "hljs-name" > wrap< / span > % < span class = "hljs-symbol" > :api< / span > )]}
[< span class = "hljs-string" > " /ping" < / span > handler]
2018-02-11 19:36:11 +00:00
< span class = "hljs-comment" > ;; a middleware vector at top level< / span >
2017-10-29 07:30:23 +00:00
[< span class = "hljs-string" > " /admin" < / span > {< span class = "hljs-symbol" > :middleware< / span > [[wrap < span class = "hljs-symbol" > :admin< / span > ]]}
[< span class = "hljs-string" > " /db" < / span > {< span class = "hljs-symbol" > :middleware< / span > [[wrap < span class = "hljs-symbol" > :db< / span > ]]
2018-02-11 19:36:11 +00:00
< span class = "hljs-comment" > ;; a middleware vector at under a method< / span >
2017-10-31 08:26:41 +00:00
< span class = "hljs-symbol" > :delete< / span > {< span class = "hljs-symbol" > :middleware< / span > [[wrap < span class = "hljs-symbol" > :delete< / span > ]]
2017-10-29 07:30:23 +00:00
< span class = "hljs-symbol" > :handler< / span > handler}}]]])))
< / code > < / pre >
< p > Middleware is applied correctly:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :delete< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api/ping" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body [:api :handler]}< / span >
< / code > < / pre >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :delete< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api/admin/db" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body [:api :admin :db :delete :handler]}< / span >
< / code > < / pre >
2018-09-22 18:52:00 +00:00
< p > Top-level middleware, applied before any routing is done:< / p >
< pre > < code class = "lang-clj" > (< 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" > " /api" < / span > {< span class = "hljs-symbol" > :middleware< / span > [[mw < span class = "hljs-symbol" > :api< / span > ]]}
[< span class = "hljs-string" > " /get" < / span > {< span class = "hljs-symbol" > :get< / span > handler}]])
< span class = "hljs-literal" > nil< / span >
{< span class = "hljs-symbol" > :middleware< / span > [[mw < span class = "hljs-symbol" > :top< / span > ]]}))
(< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api/get" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body [:top :api :ok]}< / span >
< / code > < / pre >
2017-10-29 07:30:23 +00:00
< / 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 >
2018-09-03 15:58:24 +00:00
< a href = "../coercion/data_spec_coercion.html" class = "navigation navigation-prev " aria-label = "Previous page: Data-specs" >
2017-10-29 07:30:23 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2018-06-14 10:29:02 +00:00
< a href = "reverse_routing.html" class = "navigation navigation-next " aria-label = "Next page: Reverse-routing" >
2017-10-29 07:30:23 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2019-01-17 17:41:19 +00:00
gitbook.page.hasChanged({"page":{"title":"Ring-router","level":"4.1","depth":1,"next":{"title":"Reverse-routing","level":"4.2","depth":1,"path":"ring/reverse_routing.md","ref":"ring/reverse_routing.md","articles":[]},"previous":{"title":"Data-specs","level":"3.4","depth":1,"path":"coercion/data_spec_coercion.md","ref":"coercion/data_spec_coercion.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":"ring/ring.md","mtime":"2019-01-17T17:40:49.512Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-17T17:41:15.391Z"},"basePath":"..","book":{"language":""}});
2017-10-29 07:30:23 +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 >
