2019-01-30 14:34:15 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > RESTful form methods · GitBook< / title >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" / >
< meta name = "description" content = "" >
< meta name = "generator" content = "GitBook 3.2.3" >
< link rel = "stylesheet" href = "../gitbook/style.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-hints/plugin-hints.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-highlight/website.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-search/search.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-fontsettings/website.css" >
< meta name = "HandheldFriendly" content = "true" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1, user-scalable=no" >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< meta name = "apple-mobile-web-app-status-bar-style" content = "black" >
< link rel = "apple-touch-icon-precomposed" sizes = "152x152" href = "../gitbook/images/apple-touch-icon-precomposed-152.png" >
< link rel = "shortcut icon" href = "../gitbook/images/favicon.ico" type = "image/x-icon" >
< link rel = "next" href = "../http/interceptors.html" / >
< link rel = "prev" href = "swagger.html" / >
< / head >
< body >
< div class = "book" >
< div class = "book-summary" >
< div id = "book-search-input" role = "search" >
< input type = "text" placeholder = "Type to search" / >
< / div >
< nav role = "navigation" >
< ul class = "summary" >
< li class = "header" > Introduction< / li >
< li class = "chapter " data-level = "1.1" data-path = "../" >
< a href = "../" >
Introduction
< / a >
< / li >
< li class = "header" > Basics< / li >
< li class = "chapter " data-level = "2.1" data-path = "../basics/route_syntax.html" >
< a href = "../basics/route_syntax.html" >
Route Syntax
< / a >
< / li >
< li class = "chapter " data-level = "2.2" data-path = "../basics/router.html" >
< a href = "../basics/router.html" >
Router
< / a >
< / li >
< li class = "chapter " data-level = "2.3" data-path = "../basics/path_based_routing.html" >
< a href = "../basics/path_based_routing.html" >
Path-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "2.4" data-path = "../basics/name_based_routing.html" >
< a href = "../basics/name_based_routing.html" >
Name-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "2.5" data-path = "../basics/route_data.html" >
< a href = "../basics/route_data.html" >
Route Data
< / a >
< / li >
< li class = "chapter " data-level = "2.6" data-path = "../basics/route_data_validation.html" >
< a href = "../basics/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
< li class = "chapter " data-level = "2.7" data-path = "../basics/route_conflicts.html" >
< a href = "../basics/route_conflicts.html" >
Route Conflicts
< / a >
< / li >
< li class = "header" > Coercion< / li >
< li class = "chapter " data-level = "3.1" data-path = "../coercion/coercion.html" >
< a href = "../coercion/coercion.html" >
Coercion Explained
< / a >
< / li >
< li class = "chapter " data-level = "3.2" data-path = "../coercion/schema_coercion.html" >
< a href = "../coercion/schema_coercion.html" >
Plumatic Schema
< / a >
< / li >
< li class = "chapter " data-level = "3.3" data-path = "../coercion/clojure_spec_coercion.html" >
< a href = "../coercion/clojure_spec_coercion.html" >
Clojure.spec
< / a >
< / li >
< li class = "chapter " data-level = "3.4" data-path = "../coercion/data_spec_coercion.html" >
< a href = "../coercion/data_spec_coercion.html" >
Data-specs
< / a >
< / li >
< li class = "header" > Ring< / li >
< li class = "chapter " data-level = "4.1" data-path = "ring.html" >
< a href = "ring.html" >
Ring-router
< / a >
< / li >
< li class = "chapter " data-level = "4.2" data-path = "reverse_routing.html" >
< a href = "reverse_routing.html" >
Reverse-routing
< / a >
< / li >
< li class = "chapter " data-level = "4.3" data-path = "default_handler.html" >
< a href = "default_handler.html" >
Default handler
< / a >
< / li >
< 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" >
< a href = "static.html" >
Static Resources
< / a >
< / li >
< li class = "chapter " data-level = "4.6" data-path = "dynamic_extensions.html" >
< a href = "dynamic_extensions.html" >
Dynamic Extensions
< / a >
< / li >
< li class = "chapter " data-level = "4.7" data-path = "data_driven_middleware.html" >
< a href = "data_driven_middleware.html" >
Data-driven Middleware
< / a >
< / li >
< li class = "chapter " data-level = "4.8" data-path = "transforming_middleware_chain.html" >
< a href = "transforming_middleware_chain.html" >
Transforming Middleware Chain
< / a >
< / li >
< li class = "chapter " data-level = "4.9" data-path = "middleware_registry.html" >
< a href = "middleware_registry.html" >
Middleware Registry
< / a >
< / li >
< li class = "chapter " data-level = "4.10" data-path = "default_middleware.html" >
< a href = "default_middleware.html" >
Default Middleware
< / a >
< / li >
< li class = "chapter " data-level = "4.11" data-path = "coercion.html" >
< a href = "coercion.html" >
2019-02-20 06:29:04 +00:00
Ring Coercion
2019-01-30 14:34:15 +00:00
< / a >
< / li >
< li class = "chapter " data-level = "4.12" data-path = "route_data_validation.html" >
< a href = "route_data_validation.html" >
Route Data Validation
< / a >
< / li >
< li class = "chapter " data-level = "4.13" data-path = "compiling_middleware.html" >
< a href = "compiling_middleware.html" >
Compiling Middleware
< / a >
< / li >
< li class = "chapter " data-level = "4.14" data-path = "swagger.html" >
< a href = "swagger.html" >
Swagger Support
< / a >
< / li >
< li class = "chapter active" data-level = "4.15" data-path = "RESTful_form_methods.html" >
< a href = "RESTful_form_methods.html" >
RESTful form methods
< / a >
< / li >
< li class = "header" > HTTP< / li >
< li class = "chapter " data-level = "5.1" data-path = "../http/interceptors.html" >
< a href = "../http/interceptors.html" >
Interceptors
< / a >
< / li >
< li class = "chapter " data-level = "5.2" data-path = "../http/pedestal.html" >
< a href = "../http/pedestal.html" >
Pedestal
< / a >
< / li >
< li class = "chapter " data-level = "5.3" data-path = "../http/sieppari.html" >
< 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" >
Default Interceptors
< / a >
< / 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 >
< / li >
< li class = "header" > Frontend< / li >
< li class = "chapter " data-level = "6.1" data-path = "../frontend/basics.html" >
< a href = "../frontend/basics.html" >
Basics
< / a >
< / li >
< li class = "chapter " data-level = "6.2" data-path = "../frontend/browser.html" >
< a href = "../frontend/browser.html" >
Browser integration
< / a >
< / li >
< li class = "chapter " data-level = "6.3" data-path = "../frontend/controllers.html" >
< a href = "../frontend/controllers.html" >
Controllers
< / a >
< / li >
< li class = "header" > Advanced< / li >
< li class = "chapter " data-level = "7.1" data-path = "../advanced/configuring_routers.html" >
< a href = "../advanced/configuring_routers.html" >
Configuring Routers
< / a >
< / li >
< li class = "chapter " data-level = "7.2" data-path = "../advanced/composing_routers.html" >
< a href = "../advanced/composing_routers.html" >
Composing Routers
< / a >
< / li >
< li class = "chapter " data-level = "7.3" data-path = "../advanced/different_routers.html" >
< a href = "../advanced/different_routers.html" >
Different Routers
< / a >
< / li >
< li class = "chapter " data-level = "7.4" data-path = "../advanced/route_validation.html" >
< a href = "../advanced/route_validation.html" >
Route Validation
< / a >
< / li >
< li class = "chapter " data-level = "7.5" data-path = "../advanced/dev_workflow.html" >
< a href = "../advanced/dev_workflow.html" >
Dev Workflow
< / a >
< / li >
< li class = "chapter " data-level = "7.6" data-path = "../advanced/shared_routes.html" >
< a href = "../advanced/shared_routes.html" >
Shared Routes
< / a >
< / li >
< li class = "header" > Misc< / li >
< li class = "chapter " data-level = "8.1" data-path = "../performance.html" >
< a href = "../performance.html" >
Performance
< / a >
< / li >
< li class = "chapter " data-level = "8.2" data-path = "../development.html" >
< a href = "../development.html" >
Development Instructions
< / a >
< / li >
< li class = "chapter " data-level = "8.3" data-path = "../faq.html" >
< a href = "../faq.html" >
FAQ
< / a >
< / li >
< li class = "divider" > < / li >
< li >
< a href = "https://www.gitbook.com" target = "blank" class = "gitbook-link" >
Published with GitBook
< / a >
< / li >
< / ul >
< / nav >
< / div >
< div class = "book-body" >
< div class = "body-inner" >
< div class = "book-header" role = "navigation" >
<!-- Title -->
< h1 >
< i class = "fa fa-circle-o-notch fa-spin" > < / i >
< a href = ".." > RESTful form methods< / 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 = "restful-form-methods" > RESTful form methods< / h1 >
< p > When designing RESTful applications you will be doing a lot of " PATCH" and " DELETE" request, but most browsers don' t support methods other than " GET" and " POST" when it comes to submitting forms. < / p >
< p > There is a pattern to solve this (pioneered by Rails) using a hidden " _method" field in the form and swapping out the " POST" method for whatever is in that field.< / p >
< p > We can do this with middleware in reitit like this: < / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn-< / span > < / span > hidden-method
[request]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > keyword< / span > < / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > or< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > get-in< / span > < / span > request [< span class = "hljs-symbol" > :form-params< / span > < span class = "hljs-string" > " _method" < / span > ]) < span class = "hljs-comment" > ;; look for " _method" field in :form-params< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > get-in< / span > < / span > request [< span class = "hljs-symbol" > :multipart-params< / span > < span class = "hljs-string" > " _method" < / span > ])))) < span class = "hljs-comment" > ;; or in :multipart-params< / span >
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > wrap-hidden-method
{< span class = "hljs-symbol" > :name< / span > < span class = "hljs-symbol" > ::wrap-hidden-method< / span >
< span class = "hljs-symbol" > :wrap< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [handler]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [request]
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > if-let< / span > < / span > [fm (< span class = "hljs-name" > < span class = "hljs-builtin-name" > and< / span > < / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > =< / span > < / span > < span class = "hljs-symbol" > :post< / span > (< span class = "hljs-symbol" > :request-method< / span > request)) < span class = "hljs-comment" > ;; if this is a :post request< / span >
(< span class = "hljs-name" > hidden-method< / span > request))] < span class = "hljs-comment" > ;; and there is a " _method" field < / span >
(< span class = "hljs-name" > handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > assoc< / span > < / span > request < span class = "hljs-symbol" > :request-method< / span > fm)) < span class = "hljs-comment" > ;; replace :request-method< / span >
(< span class = "hljs-name" > handler< / span > request))))})
< / code > < / pre >
< p > And apply the middleware like this: < / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > reitit.ring/ring-handler< / span >
(< span class = "hljs-name" > reitit.ring/router< / span > ...)
(< span class = "hljs-name" > reitit.ring/create-default-handler< / span > )
{< span class = "hljs-symbol" > :middleware< / span >
[reitit.ring.middleware.parameters/parameters-middleware < span class = "hljs-comment" > ;; needed to have :form-params in the request map< / span >
reitit.ring.middleware.multipart/multipart-middleware < span class = "hljs-comment" > ;; needed to have :multipart-params in the request map< / span >
wrap-hidden-method]}) < span class = "hljs-comment" > ;; our hidden method wrapper< / span >
< / code > < / pre >
< p > (NOTE: This middleware must be placed here and not inside the route data given to < code > reitit.ring/handler< / code > .
This is so that our middleware is applied before reitit matches the request with a spesific handler using the wrong method.)< / p >
< / section >
< / div >
< div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > results matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< a href = "swagger.html" class = "navigation navigation-prev " aria-label = "Previous page: Swagger Support" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "../http/interceptors.html" class = "navigation navigation-next " aria-label = "Next page: Interceptors" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2019-02-20 06:51:16 +00:00
gitbook.page.hasChanged({"page":{"title":"RESTful form methods","level":"4.15","depth":1,"next":{"title":"Interceptors","level":"5.1","depth":1,"path":"http/interceptors.md","ref":"http/interceptors.md","articles":[]},"previous":{"title":"Swagger Support","level":"4.14","depth":1,"path":"ring/swagger.md","ref":"ring/swagger.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/RESTful_form_methods.md","mtime":"2019-02-20T06:50:48.734Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-20T06:51:12.598Z"},"basePath":"..","book":{"language":""}});
2019-01-30 14:34:15 +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 >
