summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAdam <adam@adambard.com>2014-09-06 10:18:31 +0200
committerAdam <adam@adambard.com>2014-09-06 10:18:31 +0200
commit014262f5c62ae1904b5e70135aca8c56540abc78 (patch)
tree5bc0babddf527c1907bac01d4a295afcb3bc504e
parentfc84512fa651d89b0e6acbd248e0b078706e7268 (diff)
Updated compojure per weavejester's suggestions
-rw-r--r--compojure.html.markdown60
1 files changed, 35 insertions, 25 deletions
diff --git a/compojure.html.markdown b/compojure.html.markdown
index 56f43cb7..1644dfb7 100644
--- a/compojure.html.markdown
+++ b/compojure.html.markdown
@@ -81,18 +81,26 @@ The body may be a function, which must accept the request as a parameter:
(GET "/" [] (fn [req] "Do something with req")))
```
-Route patterns may include named parameters,
+Or, you can just use the request directly:
+
+```clojure
+(defroutes myapp
+ (GET "/" req "Do something with req"))
+```
+
+Route patterns may include named parameters:
```clojure
(defroutes myapp
(GET "/hello/:name" [name] (str "Hello " name)))
```
-You can match entire paths with *
+You can adjust what each parameter matches by supplying a regex:
```clojure
(defroutes myapp
- (GET "/file/*.*" [*] (str *)))
+ (GET ["/file/:name.:ext" :name #".*", :ext #".*"] [name ext]
+ (str "File: " name ext))
```
Handlers may utilize query parameters:
@@ -100,10 +108,10 @@ Handlers may utilize query parameters:
```clojure
(defroutes myapp
(GET "/posts" []
- (fn [req]
- (let [title (get (:params req) "title")
- author (get (:params req) "title")]
- " Do something with title and author"))))
+ (fn [req]
+ (let [title (get (:params req) "title")
+ author (get (:params req) "title")]
+ " Do something with title and author"))))
```
Or, for POST and PUT requests, form parameters
@@ -111,10 +119,10 @@ Or, for POST and PUT requests, form parameters
```clojure
(defroutes myapp
(POST "/posts" []
- (fn [req]
- (let [title (get (:params req) "title")
- author (get (:params req) "title")]
- "Do something with title and author"))))
+ (fn [req]
+ (let [title (get (:params req) "title")
+ author (get (:params req) "title")]
+ "Do something with title and author"))))
```
@@ -123,16 +131,16 @@ Or, for POST and PUT requests, form parameters
The return value of a route block determines at least the response body
passed on to the HTTP client, or at least the next middleware in the
ring stack. Most commonly, this is a string, as in the above examples.
-But, you may also return a [response body](https://github.com/mmcgrana/ring/blob/master/SPEC):
+But, you may also return a [response map](https://github.com/mmcgrana/ring/blob/master/SPEC):
```clojure
(defroutes myapp
(GET "/" []
- {:status 200 :body "Hello World"})
+ {:status 200 :body "Hello World"})
(GET "/is-403" []
- {:status 403 :body ""})
+ {:status 403 :body ""})
(GET "/is-json" []
- {:status 200 :headers {"Content-Type" "application/json"} :body "{}"}))
+ {:status 200 :headers {"Content-Type" "application/json"} :body "{}"}))
```
### Static Files
@@ -164,7 +172,7 @@ To use templating with Compojure, you'll need a template library. Here are a few
(defroutes myapp
(GET "/hello/:name" [name]
- (render-string "Hello {{name}}" {:name name})))
+ (render-string "Hello {{name}}" {:name name})))
```
You can easily read in templates from your resources directory. Here's a helper function
@@ -177,7 +185,7 @@ You can easily read in templates from your resources directory. Here's a helper
(defroutes myapp
(GET "/hello/:name" [name]
- (render-string (read-template "templates/hello.html") {:name name})))
+ (render-string (read-template "templates/hello.html") {:name name})))
```
#### [Selmer](https://github.com/yogthos/Selmer)
@@ -189,7 +197,7 @@ You can easily read in templates from your resources directory. Here's a helper
(defroutes myapp
(GET "/hello/:name" [name]
- (render-file "templates/hello.html" {:name name})))
+ (render-file "templates/hello.html" {:name name})))
```
#### [Hiccup](https://github.com/weavejester/hiccup)
@@ -201,11 +209,11 @@ You can easily read in templates from your resources directory. Here's a helper
(defroutes myapp
(GET "/hello/:name" [name]
- (hiccup/html
- [:html
- [:body
- [:h1 {:class "title"}
- (str "Hello " name)]]])))
+ (hiccup/html
+ [:html
+ [:body
+ [:h1 {:class "title"}
+ (str "Hello " name)]]])))
```
#### [Markdown](https://github.com/yogthos/markdown-clj)
@@ -217,9 +225,11 @@ You can easily read in templates from your resources directory. Here's a helper
(defroutes myapp
(GET "/hello/:name" [name]
- (md-to-html-string "## Hello, world")))
+ (md-to-html-string "## Hello, world")))
```
Further reading:
-[Clojure for the Brave and True](http://www.braveclojure.com/)
+* [Official Compojure Documentation](https://github.com/weavejester/compojure/wiki)
+
+* [Clojure for the Brave and True](http://www.braveclojure.com/)