2017-11-27 06:15:59 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
2019-02-20 06:29:04 +00:00
< title > Ring Coercion · GitBook< / title >
2017-11-27 06:15:59 +00:00
< 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-11-27 06:15:59 +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" >
2017-12-29 10:06:19 +00:00
< link rel = "next" href = "route_data_validation.html" / >
2017-11-27 06:15:59 +00:00
2018-08-03 07:10:16 +00:00
< link rel = "prev" href = "default_middleware.html" / >
2017-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +00:00
< a href = "../basics/route_syntax.html" >
2017-12-10 16:03:30 +00:00
Route Syntax
2017-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +00:00
< a href = "../basics/route_data.html" >
2017-12-10 16:03:30 +00:00
Route Data
2017-11-27 06:15:59 +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-11-27 06:15:59 +00:00
< a href = "../basics/route_conflicts.html" >
2017-12-10 16:03:30 +00:00
Route Conflicts
2017-11-27 06:15:59 +00:00
< / a >
2019-05-12 18:16:46 +00:00
< / li >
< li class = "chapter " data-level = "2.8" data-path = "../basics/error_messages.html" >
< a href = "../basics/error_messages.html" >
Error Messages
< / a >
2017-11-27 06:15:59 +00:00
< / 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-11-27 06:15:59 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.1" data-path = "ring.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Ring-router
2017-11-27 06:15:59 +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-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "default_handler.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Default handler
2017-11-27 06:15:59 +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-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "static.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Static Resources
2017-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "transforming_middleware_chain.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Transforming Middleware Chain
2017-11-27 06:15:59 +00:00
< / a >
2018-08-25 12:49:36 +00:00
< / li >
2017-11-27 06:15:59 +00:00
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.9" data-path = "middleware_registry.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "middleware_registry.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Middleware Registry
2017-11-27 06:15:59 +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 active" 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
2019-02-20 06:29:04 +00:00
Ring 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-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "compiling_middleware.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Compiling Middleware
2017-11-27 06:15:59 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.14" data-path = "swagger.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
< a href = "swagger.html" >
2017-11-27 06:15:59 +00:00
2018-08-25 12:49:36 +00:00
Swagger Support
2017-11-27 06:15:59 +00:00
< / a >
2019-01-30 14:32:00 +00:00
< / li >
2019-01-30 14:34:15 +00:00
< li class = "chapter " data-level = "4.15" data-path = "RESTful_form_methods.html" >
2019-01-30 14:32:00 +00:00
2019-01-30 14:34:15 +00:00
< a href = "RESTful_form_methods.html" >
2019-01-30 14:32:00 +00:00
RESTful form methods
< / a >
2017-11-27 06:15:59 +00:00
< / 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-11-27 06:15:59 +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-11-27 06:15:59 +00:00
2018-09-08 07:54:15 +00:00
Default Interceptors
2017-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../frontend/basics.html" >
2017-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +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-11-27 06:15:59 +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-27 06:15:59 +00:00
2018-02-11 19:36:11 +00:00
< a href = "../performance.html" >
2017-11-27 06:15:59 +00:00
2018-02-11 19:36:11 +00:00
Performance
2017-11-27 06:15:59 +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-11-27 06:15:59 +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 >
2019-02-20 06:29:04 +00:00
< a href = ".." > Ring Coercion< / a >
2017-11-27 06:15:59 +00:00
< / 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" >
2019-02-20 06:29:04 +00:00
< h1 id = "ring-coercion" > Ring Coercion< / h1 >
< p > Basic coercion is explained in detail < a href = "../coercion/coercion.html" > in the Coercion Guide< / a > . With Ring, both request parameters and response bodies can be coerced.< / p >
< p > The following request parameters are currently supported:< / p >
< table >
< thead >
< tr >
< th > type< / th >
< th > request source< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > :query< / code > < / td >
< td > < code > :query-params< / code > < / td >
< / tr >
< tr >
< td > < code > :body< / code > < / td >
< td > < code > :body-params< / code > < / td >
< / tr >
< tr >
< td > < code > :form< / code > < / td >
< td > < code > :form-params< / code > < / td >
< / tr >
< tr >
< td > < code > :header< / code > < / td >
< td > < code > :header-params< / code > < / td >
< / tr >
< tr >
< td > < code > :path< / code > < / td >
< td > < code > :path-params< / code > < / td >
< / tr >
< / tbody >
< / table >
2017-12-15 06:22:23 +00:00
< p > To enable coercion, the following things need to be done:< / p >
2017-11-27 06:15:59 +00:00
< ul >
2017-12-15 06:22:23 +00:00
< li > Define a < code > reitit.coercion/Coercion< / code > for the routes< / li >
< li > Define types for the parameters and/or responses< / li >
< li > Mount Coercion Middleware to apply to coercion< / li >
< li > Use the coerced parameters in a handler/middleware< / li >
2017-11-27 06:15:59 +00:00
< / ul >
2017-12-15 06:22:23 +00:00
< h2 id = "define-coercion" > Define coercion< / h2 >
< p > < code > reitit.coercion/Coercion< / code > is a protocol defining how types are defined, coerced and inventoried.< / p >
< p > Reitit ships with the following coercion modules:< / p >
< ul >
< li > < code > reitit.coercion.schema/coercion< / code > for < a href = "https://github.com/plumatic/schema" target = "_blank" > plumatic schema< / a > < / li >
< li > < code > reitit.coercion.spec/coercion< / code > for both < a href = "https://clojure.org/about/spec" target = "_blank" > clojure.spec< / a > and < a href = "https://github.com/metosin/spec-tools#data-specs" target = "_blank" > data-specs< / a > < / li >
2017-11-27 06:15:59 +00:00
< / ul >
2017-12-15 06:22:23 +00:00
< p > Coercion can be attached to route data under < code > :coercion< / code > key. There can be multiple < code > Coercion< / code > implementations within a single router, normal < a href = "../basics/route_data.html#nested-route-data" > scoping rules< / a > apply.< / p >
2018-02-11 19:36:11 +00:00
< h2 id = "defining-parameters-and-responses" > Defining parameters and responses< / h2 >
2019-02-20 06:29:04 +00:00
< p > Parameters are defined in route data under < code > :parameters< / code > key. It' s value should be a map of parameter < code > :type< / code > -> Coercion Schema.< / p >
< p > Responses are defined in route data under < code > :responses< / code > key. It' s value should be a map of http status code to a map which can contain < code > :body< / code > key with Coercion Schema as value.< / p >
< p > Below is an example with < a href = "https://github.com/plumatic/schema" target = "_blank" > Plumatic Schema< / a > . It defines schemas for < code > :query< / code > , < code > :body< / code > and < code > :path< / code > parameters and for http 200 response < code > :body< / code > .< / p >
2018-02-11 19:36:11 +00:00
< p > Handler can access the coerced parameters can be read under < code > :parameters< / code > key in the request.< / p >
2017-12-15 06:22:23 +00:00
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.coercion.schema])
2017-11-27 06:15:59 +00:00
(< span class = "hljs-name" > require< / span > ' [schema.core < span class = "hljs-symbol" > :as< / span > s])
2018-02-11 19:36:11 +00:00
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > PositiveInt (< span class = "hljs-name" > s/constrained< / span > s/Int pos? ' PositiveInt))
2017-12-15 06:22:23 +00:00
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > plus-endpoint
{< span class = "hljs-symbol" > :coercion< / span > reitit.coercion.schema/coercion
< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :query< / span > {< span class = "hljs-symbol" > :x< / span > s/Int}
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :y< / span > s/Int}
< span class = "hljs-symbol" > :path< / span > {< span class = "hljs-symbol" > :z< / span > s/Int}}
2018-02-11 20:06:26 +00:00
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > PositiveInt}}}
2017-12-15 06:22:23 +00:00
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{< span class = "hljs-symbol" > :keys< / span > [parameters]}]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > let< / span > < / span > [total (< span class = "hljs-name" > < span class = "hljs-builtin-name" > +< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :query< / span > < span class = "hljs-symbol" > :x< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :body< / span > < span class = "hljs-symbol" > :y< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :path< / span > < span class = "hljs-symbol" > :z< / span > ))]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span >
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > total}}))})
2017-11-27 06:15:59 +00:00
< / code > < / pre >
2017-12-15 06:22:23 +00:00
< h2 id = "coercion-middleware" > Coercion Middleware< / h2 >
2017-12-31 10:07:25 +00:00
< p > Defining a coercion for a route data doesn' t do anything, as it' s just data. We have to attach some code to apply the actual coercion. We can use the middleware from < code > reitit.ring.coercion< / code > :< / p >
2017-12-15 06:22:23 +00:00
< ul >
2018-02-11 19:36:11 +00:00
< li > < code > coerce-request-middleware< / code > to apply the parameter coercion< / li >
< li > < code > coerce-response-middleware< / code > to apply the response coercion< / li >
< li > < code > coerce-exceptions-middleware< / code > to transform coercion exceptions into pretty responses< / li >
2017-12-15 06:22:23 +00:00
< / ul >
2017-12-28 09:00:03 +00:00
< h3 id = "full-example" > Full example< / h3 >
< p > Here' s an full example for applying coercion with Reitit, Ring and Schema:< / p >
2017-12-31 10:07:25 +00:00
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring.coercion < span class = "hljs-symbol" > :as< / span > rrc])
2017-12-28 09:00:03 +00:00
(< span class = "hljs-name" > require< / span > ' [reitit.coercion.schema])
(< span class = "hljs-name" > require< / span > ' [reitit.ring < span class = "hljs-symbol" > :as< / span > ring])
(< span class = "hljs-name" > require< / span > ' [schema.core < span class = "hljs-symbol" > :as< / span > s])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > PositiveInt (< span class = "hljs-name" > s/constrained< / span > s/Int pos? ' PositiveInt))
2017-11-27 06:15:59 +00:00
(< 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 >
2017-12-15 06:22:23 +00:00
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::ping< / span >
< span class = "hljs-symbol" > :get< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [_]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span >
< span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " pong" < / span > })}]
[< span class = "hljs-string" > " /plus/:z" < / span > {< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::plus< / span >
< span class = "hljs-symbol" > :post< / span > {< span class = "hljs-symbol" > :coercion< / span > reitit.coercion.schema/coercion
< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :query< / span > {< span class = "hljs-symbol" > :x< / span > s/Int}
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :y< / span > s/Int}
< span class = "hljs-symbol" > :path< / span > {< span class = "hljs-symbol" > :z< / span > s/Int}}
2018-02-11 20:06:26 +00:00
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > PositiveInt}}}
2017-12-15 06:22:23 +00:00
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{< span class = "hljs-symbol" > :keys< / span > [parameters]}]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > let< / span > < / span > [total (< span class = "hljs-name" > < span class = "hljs-builtin-name" > +< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :query< / span > < span class = "hljs-symbol" > :x< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :body< / span > < span class = "hljs-symbol" > :y< / span > )
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > parameters < span class = "hljs-symbol" > :path< / span > < span class = "hljs-symbol" > :z< / span > ))]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span >
< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > total}}))}}]]
2017-12-31 10:07:25 +00:00
{< span class = "hljs-symbol" > :data< / span > {< span class = "hljs-symbol" > :middleware< / span > [rrc/coerce-exceptions-middleware
rrc/coerce-request-middleware
rrc/coerce-response-middleware]}})))
2017-11-27 06:15:59 +00:00
< / code > < / pre >
< p > Valid request:< / p >
2017-12-15 06:22:23 +00:00
< pre > < code class = "lang-clj" > (< 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" > " /api/plus/3" < / span >
< span class = "hljs-symbol" > :query-params< / span > {< span class = "hljs-string" > " x" < / span > < span class = "hljs-string" > " 1" < / span > }
< span class = "hljs-symbol" > :body-params< / span > {< span class = "hljs-symbol" > :y< / span > < span class = "hljs-number" > 2< / span > }})
< span class = "hljs-comment" > ; {:status 200, :body {:total 6}}< / span >
2017-11-27 06:15:59 +00:00
< / code > < / pre >
< p > Invalid request:< / p >
2017-12-15 06:22:23 +00:00
< pre > < code class = "lang-clj" > (< 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" > " /api/plus/3" < / span >
< span class = "hljs-symbol" > :query-params< / span > {< span class = "hljs-string" > " x" < / span > < span class = "hljs-string" > " abba" < / span > }
< span class = "hljs-symbol" > :body-params< / span > {< span class = "hljs-symbol" > :y< / span > < span class = "hljs-number" > 2< / span > }})
2017-11-27 06:15:59 +00:00
< span class = "hljs-comment" > ; {:status 400,< / span >
2017-12-15 06:22:23 +00:00
< span class = "hljs-comment" > ; :body {:schema {:x " Int" , " Any" " Any" },< / span >
< span class = "hljs-comment" > ; :errors {:x " (not (integer? \" abba\" ))" },< / span >
< span class = "hljs-comment" > ; :type :reitit.coercion/request-coercion,< / span >
< span class = "hljs-comment" > ; :coercion :schema,< / span >
< span class = "hljs-comment" > ; :value {:x " abba" },< / span >
< span class = "hljs-comment" > ; :in [:request :query-params]}}< / span >
2017-11-27 06:15:59 +00:00
< / code > < / pre >
2017-12-15 06:22:23 +00:00
< p > Invalid response:< / p >
< pre > < code class = "lang-clj" > (< 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" > " /api/plus/3" < / span >
< span class = "hljs-symbol" > :query-params< / span > {< span class = "hljs-string" > " x" < / span > < span class = "hljs-string" > " 1" < / span > }
< span class = "hljs-symbol" > :body-params< / span > {< span class = "hljs-symbol" > :y< / span > < span class = "hljs-number" > -10< / span > }})
< span class = "hljs-comment" > ; {:status 500,< / span >
< span class = "hljs-comment" > ; :body {:schema {:total " (constrained Int PositiveInt)" },< / span >
< span class = "hljs-comment" > ; :errors {:total " (not (PositiveInt -6))" },< / span >
< span class = "hljs-comment" > ; :type :reitit.coercion/response-coercion,< / span >
< span class = "hljs-comment" > ; :coercion :schema,< / span >
< span class = "hljs-comment" > ; :value {:total -6},< / span >
< span class = "hljs-comment" > ; :in [:response :body]}}< / span >
2017-11-27 06:15:59 +00:00
< / code > < / pre >
2019-01-17 17:41:19 +00:00
< h2 id = "pretty-printing-spec-errors" > Pretty printing spec errors< / h2 >
< p > Spec problems are exposed as-is into request & response coercion errors, enabling pretty-printers like < a href = "https://github.com/bhb/expound" target = "_blank" > expound< / a > to be used:< / 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" > require< / span > ' [reitit.ring.middleware.exception < span class = "hljs-symbol" > :as< / span > exception])
(< span class = "hljs-name" > require< / span > ' [reitit.ring.coercion < span class = "hljs-symbol" > :as< / span > coercion])
(< span class = "hljs-name" > require< / span > ' [expound.alpha < span class = "hljs-symbol" > :as< / span > expound])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > coercion-error-handler [status]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > let< / span > < / span > [printer (< span class = "hljs-name" > expound/custom-printer< / span > {< span class = "hljs-symbol" > :theme< / span > < span class = "hljs-symbol" > :figwheel-theme< / span > , < span class = "hljs-symbol" > :print-specs?< / span > < span class = "hljs-literal" > false< / span > })
handler (< span class = "hljs-name" > exception/create-coercion-handler< / span > status)]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [exception request]
(< span class = "hljs-name" > printer< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > exception ex-data < span class = "hljs-symbol" > :problems< / span > ))
(< span class = "hljs-name" > handler< / span > exception request))))
(< 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" > " /plus" < / span >
{< span class = "hljs-symbol" > :get< / span >
{< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :query< / span > {< span class = "hljs-symbol" > :x< / span > int?, < span class = "hljs-symbol" > :y< / span > int?}}
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > pos-int?}}}
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{{{< span class = "hljs-symbol" > :keys< / span > [x y]} < span class = "hljs-symbol" > :query< / span > } < span class = "hljs-symbol" > :parameters< / span > }]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > +< / span > < / span > x y)}})}}]
{< span class = "hljs-symbol" > :data< / span > {< span class = "hljs-symbol" > :coercion< / span > reitit.coercion.spec/coercion
< span class = "hljs-symbol" > :middleware< / span > [(< span class = "hljs-name" > exception/create-exception-middleware< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > merge< / span > < / span >
exception/default-handlers
{< span class = "hljs-symbol" > :reitit.coercion/request-coercion< / span > (< span class = "hljs-name" > coercion-error-handler< / span > < span class = "hljs-number" > 400< / span > )
< span class = "hljs-symbol" > :reitit.coercion/response-coercion< / span > (< span class = "hljs-name" > coercion-error-handler< / span > < span class = "hljs-number" > 500< / span > )}))
coercion/coerce-request-middleware
coercion/coerce-response-middleware]}})))
(< span class = "hljs-name" > app< / span >
{< span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /plus" < / span >
< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span >
< span class = "hljs-symbol" > :query-params< / span > {< span class = "hljs-string" > " x" < / span > < span class = "hljs-string" > " 1" < / span > , < span class = "hljs-string" > " y" < / span > < span class = "hljs-string" > " fail" < / span > }})
< span class = "hljs-comment" > ; => ...< / span >
< span class = "hljs-comment" > ; -- Spec failed --------------------< / span >
< span class = "hljs-comment" > ;< / span >
< span class = "hljs-comment" > ; {:x ..., :y " fail" }< / span >
< span class = "hljs-comment" > ; ^^^^^^< / span >
< span class = "hljs-comment" > ;< / span >
< span class = "hljs-comment" > ; should satisfy< / span >
< span class = "hljs-comment" > ;< / span >
< span class = "hljs-comment" > ; int?< / span >
(< span class = "hljs-name" > app< / span >
{< span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /plus" < / span >
< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span >
< span class = "hljs-symbol" > :query-params< / span > {< span class = "hljs-string" > " x" < / span > < span class = "hljs-string" > " 1" < / span > , < span class = "hljs-string" > " y" < / span > < span class = "hljs-string" > " -2" < / span > }})
< span class = "hljs-comment" > ; => ...< / span >
< span class = "hljs-comment" > ;-- Spec failed --------------------< / span >
< span class = "hljs-comment" > ;< / span >
< span class = "hljs-comment" > ; {:total -1}< / span >
< span class = "hljs-comment" > ; ^^< / span >
< span class = "hljs-comment" > ;< / span >
< span class = "hljs-comment" > ; should satisfy< / span >
< span class = "hljs-comment" > ;< / span >
< span class = "hljs-comment" > ; pos-int?< / span >
< / code > < / pre >
2017-12-15 06:22:23 +00:00
< h3 id = "optimizations" > Optimizations< / h3 >
2019-05-14 10:36:15 +00:00
< p > The coercion middleware are < a href = "compiling_middleware.html" > compiled against a route< / a > . In the middleware compilation step the actual coercer implementations are constructed for the defined models. Also, the middleware doesn' t mount itself if a route doesn' t have < code > :coercion< / code > and < code > :parameters< / code > or < code > :responses< / code > defined.< / p >
2017-12-15 06:22:23 +00:00
< p > We can query the compiled middleware chain for the routes:< / 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 > (< span class = "hljs-name" > ring/get-router< / span > app)
(< span class = "hljs-name" > r/match-by-name< / span > < span class = "hljs-symbol" > ::plus< / span > )
< span class = "hljs-symbol" > :result< / span > < span class = "hljs-symbol" > :post< / span > < span class = "hljs-symbol" > :middleware< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> > < / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > mapv< / span > < / span > < span class = "hljs-symbol" > :name< / span > )))
< span class = "hljs-comment" > ; [::mw/coerce-exceptions< / span >
2017-12-28 09:00:03 +00:00
< span class = "hljs-comment" > ; ::mw/coerce-request< / span >
2017-12-15 06:22:23 +00:00
< span class = "hljs-comment" > ; ::mw/coerce-response]< / span >
2017-11-27 06:15:59 +00:00
< / code > < / pre >
2017-12-15 06:22:23 +00:00
< p > Route without coercion defined:< / 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/ping" < / span > })
< span class = "hljs-comment" > ; {:status 200, :body " pong" }< / span >
2017-11-27 06:15:59 +00:00
< / code > < / pre >
2017-12-15 06:22:23 +00:00
< p > Has no mounted middleware:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > (< span class = "hljs-name" > ring/get-router< / span > app)
(< span class = "hljs-name" > r/match-by-name< / span > < span class = "hljs-symbol" > ::ping< / span > )
< span class = "hljs-symbol" > :result< / span > < span class = "hljs-symbol" > :get< / span > < span class = "hljs-symbol" > :middleware< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> > < / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > mapv< / span > < / span > < span class = "hljs-symbol" > :name< / span > )))
< span class = "hljs-comment" > ; []< / span >
2017-11-27 06:15:59 +00:00
< / 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 >
2018-08-03 07:10:16 +00:00
< a href = "default_middleware.html" class = "navigation navigation-prev " aria-label = "Previous page: Default Middleware" >
2017-11-27 06:15:59 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2017-12-29 10:06:19 +00:00
< a href = "route_data_validation.html" class = "navigation navigation-next " aria-label = "Next page: Route Data Validation" >
2017-11-27 06:15:59 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2019-06-27 13:42:25 +00:00
gitbook.page.hasChanged({"page":{"title":"Ring Coercion","level":"4.11","depth":1,"next":{"title":"Route Data Validation","level":"4.12","depth":1,"path":"ring/route_data_validation.md","ref":"ring/route_data_validation.md","articles":[]},"previous":{"title":"Default Middleware","level":"4.10","depth":1,"path":"ring/default_middleware.md","ref":"ring/default_middleware.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/coercion.md","mtime":"2019-06-27T13:41:29.222Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-06-27T13:42:18.283Z"},"basePath":"..","book":{"language":""}});
2017-11-27 06:15:59 +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 >
