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" >
2018-09-03 15:58:24 +00:00
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-hints/plugin-hints.css" >
2017-09-14 13:55:39 +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-09-03 15:58:24 +00:00
< link rel = "next" href = "basics/route_syntax.html" / >
2017-10-29 07:30:23 +00:00
2017-09-14 13:55:39 +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-09-14 13:55:39 +00:00
< li class = "chapter active" 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-09-14 13:55:39 +00:00
2017-10-29 07:30:23 +00:00
< a href = "basics/route_syntax.html" >
2017-09-14 13:55:39 +00:00
2017-12-10 16:03:30 +00:00
Route Syntax
2017-09-14 13:55:39 +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-09-14 13:55:39 +00:00
2017-10-29 07:30:23 +00:00
< a href = "basics/router.html" >
2017-09-14 13:55:39 +00:00
2017-09-18 05:30:53 +00:00
Router
2017-09-14 13:55:39 +00:00
< / 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-09-14 13:55:39 +00:00
2017-10-29 07:30:23 +00:00
< a href = "basics/path_based_routing.html" >
2017-09-14 13:55:39 +00:00
2017-09-18 05:30:53 +00:00
Path-based Routing
2017-09-14 13:55:39 +00:00
< / 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-09-14 13:55:39 +00:00
2017-10-29 07:30:23 +00:00
< a href = "basics/name_based_routing.html" >
2017-09-14 13:55:39 +00:00
2017-09-18 05:30:53 +00:00
Name-based Routing
2017-09-14 13:55:39 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.5" data-path = "basics/route_data.html" >
2017-09-18 05:30:53 +00:00
2017-10-29 07:30:23 +00:00
< a href = "basics/route_data.html" >
2017-09-18 05:30:53 +00:00
2017-12-10 16:03:30 +00:00
Route Data
2017-09-18 05:30:53 +00:00
< / a >
2017-09-14 13:55:39 +00:00
< / 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-09-14 13:55:39 +00:00
2017-10-31 08:26:41 +00:00
< a href = "basics/route_conflicts.html" >
2017-09-14 13:55:39 +00:00
2017-12-10 16:03:30 +00:00
Route Conflicts
2017-09-14 13:55:39 +00:00
< / a >
< / li >
2017-09-18 05:30:53 +00:00
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-09-14 13:55:39 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.1" data-path = "ring/ring.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/ring.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
Ring-router
2017-09-14 13:55:39 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.2" data-path = "ring/reverse_routing.html" >
2018-07-18 10:13:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/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 = "ring/default_handler.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/default_handler.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
Default handler
2017-09-14 13:55:39 +00:00
< / 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" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/static.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
Static Resources
2017-09-14 13:55:39 +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 = "ring/dynamic_extensions.html" >
2018-03-15 06:09:15 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/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-09-14 13:55:39 +00:00
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.7" data-path = "ring/data_driven_middleware.html" >
2018-08-25 12:49:36 +00:00
< a href = "ring/data_driven_middleware.html" >
Data-driven Middleware
< / a >
2017-09-18 05:30:53 +00:00
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.8" data-path = "ring/transforming_middleware_chain.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/transforming_middleware_chain.html" >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
Transforming Middleware Chain
2017-09-14 13:55:39 +00:00
2017-10-29 07:30:23 +00:00
< / a >
2017-09-14 13:55:39 +00:00
2018-08-25 12:49:36 +00:00
< / li >
2017-09-18 05:30:53 +00:00
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.9" data-path = "ring/middleware_registry.html" >
2017-09-18 05:30:53 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/middleware_registry.html" >
2017-09-18 05:30:53 +00:00
2018-08-25 12:49:36 +00:00
Middleware Registry
2017-09-18 05:30:53 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.10" data-path = "ring/default_middleware.html" >
2018-06-14 10:29:02 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/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 = "ring/coercion.html" >
2018-04-25 18:13:54 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/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 = "ring/route_data_validation.html" >
2018-04-25 09:50:40 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/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 = "ring/compiling_middleware.html" >
2017-09-18 05:30:53 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/compiling_middleware.html" >
2017-09-18 05:30:53 +00:00
2018-08-25 12:49:36 +00:00
Compiling Middleware
2017-09-18 05:30:53 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.14" data-path = "ring/swagger.html" >
2017-10-31 08:26:41 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring/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-09-18 05:30:53 +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-09-18 05:30:53 +00:00
2018-09-08 07:54:15 +00:00
Default Interceptors
2017-09-18 05:30:53 +00:00
< / a >
< / 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-09-18 05:30:53 +00:00
2018-09-08 07:54:15 +00:00
< a href = "frontend/basics.html" >
2017-09-18 05:30:53 +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-09-18 05:30:53 +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-09-18 05:30:53 +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-09-18 05:30:53 +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-09-14 13:55:39 +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 = "." > 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" >
2017-09-18 05:30:53 +00:00
< h1 id = "introduction" > Introduction< / h1 >
2018-02-11 19:36:11 +00:00
< p > < a href = "https://github.com/metosin/reitit" target = "_blank" > Reitit< / a > is a fast data-driven router for Clojure(Script).< / p >
2017-09-14 13:55:39 +00:00
< ul >
2017-10-29 07:30:23 +00:00
< li > Simple data-driven < a href = "basics/route_syntax.html" > route syntax< / a > < / li >
2017-11-27 06:15:59 +00:00
< li > < a href = "basics/route_conflicts.html" > Route conflict resolution< / a > < / li >
2017-11-18 11:35:40 +00:00
< li > First-class < a href = "basics/route_data.html" > route data< / a > < / li >
2017-10-29 07:30:23 +00:00
< li > Bi-directional routing< / li >
2017-12-10 16:03:30 +00:00
< li > < a href = "coercion/coercion.html" > Pluggable coercion< / a > (< a href = "https://github.com/plumatic/schema" target = "_blank" > schema< / a > & < a href = "https://clojure.org/about/spec" target = "_blank" > clojure.spec< / a > )< / li >
2018-09-09 18:54:06 +00:00
< li > Helpers for < a href = "ring/ring.html" > ring< / a > , < a href = "http/interceptors.html" > http< / a > & < a href = "frontend/basics.html" > the browser< / a > < / li >
2017-09-14 13:55:39 +00:00
< li > Extendable< / li >
2017-11-27 06:15:59 +00:00
< li > Modular< / li >
2017-11-01 08:18:52 +00:00
< li > < a href = "performance.html" > Fast< / a > < / li >
2017-09-14 13:55:39 +00:00
< / ul >
2018-05-20 16:52:28 +00:00
< p > Modules:< / p >
2018-02-02 07:08:25 +00:00
< ul >
2018-08-25 12:49:36 +00:00
< li > < code > reitit< / code > - all bundled< / li >
2018-05-20 16:52:28 +00:00
< li > < code > reitit-core< / code > - the routing core< / li >
2018-08-25 12:49:36 +00:00
< li > < code > reitit-ring< / code > - a < a href = "ring/ring.html" > ring router< / a > < / li >
< li > < code > reitit-middleware< / code > - < a href = "ring/default_middleware.html" > common middleware< / a > for < code > reitit-ring< / code > < / li >
2018-05-20 16:52:28 +00:00
< li > < code > reitit-spec< / code > < a href = "https://clojure.org/about/spec" target = "_blank" > clojure.spec< / a > coercion< / li >
< li > < code > reitit-schema< / code > < a href = "https://github.com/plumatic/schema" target = "_blank" > Schema< / a > coercion< / li >
< li > < code > reitit-swagger< / code > < a href = "https://swagger.io/" target = "_blank" > Swagger2< / a > apidocs< / li >
< li > < code > reitit-swagger-ui< / code > Integrated < a href = "https://github.com/swagger-api/swagger-ui" target = "_blank" > Swagger UI< / a > .< / li >
2018-08-31 07:51:04 +00:00
< li > < code > reitit-frontend< / code > Tools for < a href = "frontend/basics.html" > frontend routing< / a > < / li >
2018-09-08 07:54:15 +00:00
< li > < code > reitit-http< / code > http-routing with Pedestal-style Interceptors< / li >
2018-09-08 07:58:43 +00:00
< li > < code > reitit-interceptors< / code > - < a href = "http/default_interceptors.html" > common interceptors< / a > for < code > reitit-http< / code > < / li >
2018-09-08 07:54:15 +00:00
< li > < code > reitit-sieppari< / code > support for < a href = "https://github.com/metosin/sieppari" target = "_blank" > Sieppari< / a > Interceptors< / li >
2018-08-25 12:49:36 +00:00
< / ul >
< h2 id = "latest-version" > Latest version< / h2 >
< p > All bundled:< / p >
2018-11-21 14:03:45 +00:00
< pre > < code class = "lang-clj" > [metosin/reitit < span class = "hljs-string" > " 0.2.9" < / span > ]
2017-09-18 05:30:53 +00:00
< / code > < / pre >
2017-11-01 16:57:26 +00:00
< p > Optionally, the parts can be required separately:< / p >
2018-11-21 14:03:45 +00:00
< pre > < code class = "lang-clj" > [metosin/reitit-core < span class = "hljs-string" > " 0.2.9" < / span > ]
2018-08-25 12:49:36 +00:00
< span class = "hljs-comment" > ;; coercion< / span >
2018-11-21 14:03:45 +00:00
[metosin/reitit-spec < span class = "hljs-string" > " 0.2.9" < / span > ]
[metosin/reitit-schema < span class = "hljs-string" > " 0.2.9" < / span > ]
2018-08-25 12:49:36 +00:00
< span class = "hljs-comment" > ;; ring helpers< / span >
2018-11-21 14:03:45 +00:00
[metosin/reitit-ring < span class = "hljs-string" > " 0.2.9" < / span > ]
[metosin/reitit-middleware < span class = "hljs-string" > " 0.2.9" < / span > ]
2018-08-25 12:49:36 +00:00
< span class = "hljs-comment" > ;; swagger-support for ring & http< / span >
2018-11-21 14:03:45 +00:00
[metosin/reitit-swagger < span class = "hljs-string" > " 0.2.9" < / span > ]
[metosin/reitit-swagger-ui < span class = "hljs-string" > " 0.2.9" < / span > ]
2018-08-25 12:49:36 +00:00
2018-09-03 16:08:56 +00:00
< span class = "hljs-comment" > ;; frontend helpers< / span >
2018-11-21 14:03:45 +00:00
[metosin/reitit-frontend < span class = "hljs-string" > " 0.2.9" < / span > ]
2018-08-25 12:49:36 +00:00
2018-09-08 07:54:15 +00:00
< span class = "hljs-comment" > ;; http with interceptors< / span >
2018-11-21 14:03:45 +00:00
[metosin/reitit-http < span class = "hljs-string" > " 0.2.9" < / span > ]
[metosin/reitit-interceptors < span class = "hljs-string" > " 0.2.9" < / span > ]
[metosin/reitit-sieppari < span class = "hljs-string" > " 0.2.9" < / span > ]
2017-11-01 16:57:26 +00:00
< / code > < / pre >
2018-08-25 12:49:36 +00:00
< p > There is < a href = "https://clojurians.slack.com/messages/reitit/" target = "_blank" > #reitit< / a > in < a href = "http://clojurians.net/" target = "_blank" > Clojurians Slack< / a > for discussion & help.< / p >
2017-09-18 05:30:53 +00:00
< h1 id = "examples" > Examples< / h1 >
< h2 id = "simple-router" > Simple router< / h2 >
< 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 >
[[< span class = "hljs-string" > " /api/ping" < / span > < span class = "hljs-symbol" > ::ping< / span > ]
[< span class = "hljs-string" > " /api/orders/:id" < / span > < span class = "hljs-symbol" > ::order-by-id< / span > ]]))
< / code > < / pre >
< p > Routing:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > r/match-by-path< / span > router < span class = "hljs-string" > " /api/ipa" < / span > )
< span class = "hljs-comment" > ; nil< / span >
(< span class = "hljs-name" > r/match-by-path< / span > router < span class = "hljs-string" > " /api/ping" < / span > )
< span class = "hljs-comment" > ; #Match{:template " /api/ping" < / span >
2017-11-18 11:35:40 +00:00
< span class = "hljs-comment" > ; :data {:name ::ping}< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :result nil< / span >
2018-02-02 07:08:25 +00:00
< span class = "hljs-comment" > ; :path-params {}< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :path " /api/ping" }< / span >
(< span class = "hljs-name" > r/match-by-path< / span > router < span class = "hljs-string" > " /api/orders/1" < / span > )
< span class = "hljs-comment" > ; #Match{:template " /api/orders/:id" < / span >
2017-11-18 11:35:40 +00:00
< span class = "hljs-comment" > ; :data {:name ::order-by-id}< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :result nil< / span >
2018-02-02 07:08:25 +00:00
< span class = "hljs-comment" > ; :path-params {:id " 1" }< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :path " /api/orders/1" }< / span >
< / code > < / pre >
< p > Reverse-routing:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > r/match-by-name< / span > router < span class = "hljs-symbol" > ::ipa< / span > )
< span class = "hljs-comment" > ; nil< / span >
(< span class = "hljs-name" > r/match-by-name< / span > router < span class = "hljs-symbol" > ::ping< / span > )
< span class = "hljs-comment" > ; #Match{:template " /api/ping" < / span >
2017-11-18 11:35:40 +00:00
< span class = "hljs-comment" > ; :data {:name ::ping}< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :result nil< / span >
2018-02-02 07:08:25 +00:00
< span class = "hljs-comment" > ; :path-params {}< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :path " /api/ping" }< / span >
(< span class = "hljs-name" > r/match-by-name< / span > router < span class = "hljs-symbol" > ::order-by-id< / span > )
< span class = "hljs-comment" > ; #PartialMatch{:template " /api/orders/:id" < / span >
2017-11-18 11:35:40 +00:00
< span class = "hljs-comment" > ; :data {:name :user/order-by-id}< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :result nil< / span >
2018-02-02 07:08:25 +00:00
< span class = "hljs-comment" > ; :path-params nil< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :required #{:id}}< / span >
(< span class = "hljs-name" > r/partial-match?< / span > (< span class = "hljs-name" > r/match-by-name< / span > router < span class = "hljs-symbol" > ::order-by-id< / span > ))
< span class = "hljs-comment" > ; true< / span >
(< span class = "hljs-name" > r/match-by-name< / span > router < span class = "hljs-symbol" > ::order-by-id< / span > {< span class = "hljs-symbol" > :id< / span > < span class = "hljs-number" > 2< / span > })
< span class = "hljs-comment" > ; #Match{:template " /api/orders/:id" ,< / span >
2017-11-18 11:35:40 +00:00
< span class = "hljs-comment" > ; :data {:name ::order-by-id},< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :result nil,< / span >
2018-02-02 07:08:25 +00:00
< span class = "hljs-comment" > ; :path-params {:id 2},< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :path " /api/orders/2" }< / span >
< / code > < / pre >
< h2 id = "ring-router" > Ring-router< / h2 >
< p > Ring-router adds support for < code > :handler< / code > functions, < code > :middleware< / code > and routing based on < code > :request-method< / code > . It also supports pluggable parameter coercion (< code > clojure.spec< / code > ), data-driven middleware, route and middleware compilation, dynamic extensions and more.< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring < span class = "hljs-symbol" > :as< / span > ring])
2018-04-29 08:34:56 +00:00
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > handler [_]
2017-09-18 05:30:53 +00:00
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " ok" < / span > })
(< 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" > update< / span > (< span class = "hljs-name" > handler< / span > request) < span class = "hljs-symbol" > :wrap< / span > (< span class = "hljs-name" > fnil< / span > conj ' ()) id)))
(< 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 > [[wrap < span class = "hljs-symbol" > :api< / span > ]]}
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :get< / span > handler
< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::ping< / span > }]
[< span class = "hljs-string" > " /admin" < / span > {< span class = "hljs-symbol" > :middleware< / span > [[wrap < span class = "hljs-symbol" > :admin< / span > ]]}
[< span class = "hljs-string" > " /users" < / span > {< span class = "hljs-symbol" > :get< / span > handler
< span class = "hljs-symbol" > :post< / span > handler}]]])))
< / code > < / pre >
< p > Routing:< / 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" > " /api/admin/users" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body " ok" , :wrap (:api :admin}< / 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" > " /api/admin/users" < / span > })
< span class = "hljs-comment" > ; nil< / span >
< / code > < / pre >
< p > Reverse-routing:< / 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" > -> < / span > < / span > app (< span class = "hljs-name" > ring/get-router< / span > ) (< span class = "hljs-name" > r/match-by-name< / span > < span class = "hljs-symbol" > ::ping< / span > ))
< span class = "hljs-comment" > ; #Match{:template " /api/ping" < / span >
2017-11-18 11:35:40 +00:00
< span class = "hljs-comment" > ; :data {:middleware [[#object[user$wrap] :api]]< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :get {:handler #object[user$handler]}< / span >
< span class = "hljs-comment" > ; :name ::ping}< / span >
< span class = "hljs-comment" > ; :result #Methods{...}< / span >
2018-02-02 07:08:25 +00:00
< span class = "hljs-comment" > ; :path-params nil< / span >
2017-09-18 05:30:53 +00:00
< span class = "hljs-comment" > ; :path " /api/ping" }< / span >
< / code > < / pre >
2017-09-14 13:55:39 +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 = "basics/route_syntax.html" class = "navigation navigation-next navigation-unique" aria-label = "Next page: Route Syntax" >
2017-10-29 07:30:23 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2017-09-14 13:55:39 +00:00
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-12-27 14:08:24 +00:00
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Route Syntax","level":"2.1","depth":1,"path":"basics/route_syntax.md","ref":"basics/route_syntax.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":"README.md","mtime":"2018-12-27T14:07:51.770Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-27T14:08:19.567Z"},"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 >
