1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
# Ring-JSON
[](https://travis-ci.org/ring-clojure/ring-json)
Standard Ring middleware functions for handling JSON requests and
responses.
## Installation
To install, add the following to your project `:dependencies`:
[ring/ring-json "0.4.0"]
## Usage
#### wrap-json-response
The `wrap-json-response` middleware will convert any response with a
collection as a body (e.g. map, vector, set, seq, etc) into JSON:
```clojure
(require '[ring.middleware.json :refer [wrap-json-response]]
'[ring.util.response :refer [response]])
(defn handler [request]
(response {:foo "bar"}))
(def app
(wrap-json-response handler))
```
#### wrap-json-body
The `wrap-json-body` middleware will parse the body of any request
with a JSON content-type into a Clojure data structure, and assign it
to the `:body` key.
This is the preferred way of handling JSON requests.
```clojure
(use '[ring.middleware.json :only [wrap-json-body]]
'[ring.util.response :only [response]])
(defn handler [request]
(prn (get-in request [:body "user"]))
(response "Uploaded user."))
(def app
(wrap-json-body handler {:keywords? true :bigdecimals? true}))
```
#### wrap-json-params
The `wrap-json-params` middleware is an alternative to
`wrap-json-body` for when it's convenient to treat a JSON request as a
map of parameters. Rather than replace the `:body` key, the parsed
data structure will be assigned to the `:json-params`. The parameters
will also be merged into the standard `:params` map.
```clojure
(require '[ring.middleware.json :refer [wrap-json-params]]
'[ring.util.response :refer [response]])
(defn handler [request]
(prn (get-in request [:params "user"]))
(response "Uploaded user."))
(def app
(wrap-json-params handler))
```
Note that Ring parameter maps use strings for keys. For consistency,
this means that `wrap-json-params` does not have a `:keywords?`
option. Instead, use the standard Ring `wrap-keyword-params` function:
```clojure
(require '[ring.middleware.keyword-params :refer [wrap-keyword-params]])
(def app
(-> handler
wrap-keyword-params
wrap-json-params))
```
## License
Copyright © 2015 James Reeves
Distributed under the MIT License, the same as Ring.
|
