Compare commits
448 commits
0.7.0-alph
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7c1544c3ce | ||
|
|
0724c0c5a0 | ||
|
|
7051c99e99 | ||
|
|
4c8a69c616 | ||
|
|
e3306e1876 | ||
|
|
e6e1bfd5c4 | ||
|
|
8391fafbe2 | ||
|
|
97bfafa907 | ||
|
|
71a777b4fa | ||
|
|
a6b68cc3d6 | ||
|
|
248200aad3 | ||
|
|
bf18586d75 | ||
|
|
373ea9bb62 | ||
|
|
334a42e03d | ||
|
|
5ac4e65284 | ||
|
|
dbac18546b | ||
|
|
69b23c49b9 | ||
|
|
e1d5789f40 | ||
|
|
d27454efdc | ||
|
|
1d4473e1f4 | ||
|
|
75faf709e2 | ||
|
|
2c87d90bda | ||
|
|
8907dfc5f5 | ||
|
|
63429a2d1e | ||
|
|
8721c7ae37 | ||
|
|
e3180e4d6a | ||
|
|
2597d14125 | ||
|
|
54a040f136 | ||
|
|
e4c53a64e2 | ||
|
|
218f05972e | ||
|
|
e342ac5401 | ||
|
|
e6137cb47a | ||
|
|
3191d9ee59 | ||
|
|
579eb28a50 | ||
|
|
20735730c9 | ||
|
|
aa6c1ac460 | ||
|
|
c113bded4e | ||
|
|
ed6397cd05 | ||
|
|
c3a152a44e | ||
|
|
c0bc789863 | ||
|
|
78aba57d2d | ||
|
|
451b286f1d | ||
|
|
eb06404f1e | ||
|
|
af7313bd9b | ||
|
|
ea58100fec | ||
|
|
a4576cc622 | ||
|
|
9d88d92241 | ||
|
|
d16aac673e | ||
|
|
dede2db213 | ||
|
|
1dc961f661 | ||
|
|
2ce9850de6 | ||
|
|
0bc30e9361 | ||
|
|
9b26d5c0fd | ||
|
|
e671f78741 | ||
|
|
55f8d98bde | ||
|
|
342bae3ffe | ||
|
|
ae52000b29 | ||
|
|
39c5ae86a4 | ||
|
|
7fb9c27e46 | ||
|
|
f4da07c222 | ||
|
|
d25dca19f6 | ||
|
|
1b02662c78 | ||
|
|
36af88b65e | ||
|
|
152c598858 | ||
|
|
6d9632e85e | ||
|
|
5ff8ba2e3e | ||
|
|
c684c83c99 | ||
|
|
defebb0f1f | ||
|
|
54c0935078 | ||
|
|
cde050f964 | ||
|
|
560c6d7969 | ||
|
|
abe95bfc17 | ||
|
|
d2f44b8015 | ||
|
|
ef9dd495be | ||
|
|
9509e40dae | ||
|
|
67918a3f9c | ||
|
|
45951aa82e | ||
|
|
1cdca2e3d5 | ||
|
|
2f22838820 | ||
|
|
d809291553 | ||
|
|
4e572e86d6 | ||
|
|
10700e0ca2 | ||
|
|
3e0f1d3188 | ||
|
|
f26dc1ab19 | ||
|
|
01766ee211 | ||
|
|
79627aea7b | ||
|
|
4d284385ec | ||
|
|
31fa0376cf | ||
|
|
05bc331397 | ||
|
|
7520d20f12 | ||
|
|
210f20e714 | ||
|
|
aad054ef39 | ||
|
|
653db7efa3 | ||
|
|
5025ca3a75 | ||
|
|
55c30af979 | ||
|
|
9ee8e364f3 | ||
|
|
ad9cd31168 | ||
|
|
99267d2943 | ||
|
|
ecf22d5c4a | ||
|
|
1803643f1f | ||
|
|
f247751409 | ||
|
|
48fdb692ef | ||
|
|
b9cef492f8 | ||
|
|
524d0d4d57 | ||
|
|
20c28ecc7c | ||
|
|
3793a7b23b | ||
|
|
ef64fc50b8 | ||
|
|
15987d9952 | ||
|
|
2bf8aa98a7 | ||
|
|
832d9ebe95 | ||
|
|
4b7a596ece | ||
|
|
0454e8914f | ||
|
|
7a77c9f86b | ||
|
|
a8b4bc0d2d | ||
|
|
9db58f21dc | ||
|
|
9797725ae8 | ||
|
|
3c6139950c | ||
|
|
9534f6df8b | ||
|
|
a390180975 | ||
|
|
f038fe1941 | ||
|
|
8058cecae0 | ||
|
|
dd835e73a8 | ||
|
|
78cf477b88 | ||
|
|
2d1d0cc5d2 | ||
|
|
75a5e816a9 | ||
|
|
e16c95c5b3 | ||
|
|
91fa60324f | ||
|
|
6dd9cb1b7c | ||
|
|
fa28489b63 | ||
|
|
9849ed5ebb | ||
|
|
a103411bf7 | ||
|
|
a57662693c | ||
|
|
44d54cc9f2 | ||
|
|
3342e77538 | ||
|
|
8fb44467a0 | ||
|
|
c2feb5b983 | ||
|
|
9fb0b7233a | ||
|
|
89c05932dc | ||
|
|
2f1defe3cd | ||
|
|
f50feff63c | ||
|
|
34e6db0d3f | ||
|
|
04cb70f1f7 | ||
|
|
58195eed68 | ||
|
|
d5d46d5b0b | ||
|
|
f0fc440425 | ||
|
|
30fd739fa9 | ||
|
|
de0e1f4462 | ||
|
|
34b6bb9349 | ||
|
|
3fcd6cfd73 | ||
|
|
e5483cb1fc | ||
|
|
481c653139 | ||
|
|
5ca22193d0 | ||
|
|
4eb29d3ed9 | ||
|
|
dfc5a4ef67 | ||
|
|
7e9116f77e | ||
|
|
7ae118fbb5 | ||
|
|
ce6d9e26cd | ||
|
|
7ae2bfafc2 | ||
|
|
1b37c87aa2 | ||
|
|
f60a7ad902 | ||
|
|
1ba77a7267 | ||
|
|
21e5840f13 | ||
|
|
5f10465533 | ||
|
|
dba8d159cc | ||
|
|
5829e1c656 | ||
|
|
1819fa5d75 | ||
|
|
25dd0abcaf | ||
|
|
a19b6034dd | ||
|
|
0256642f64 | ||
|
|
b1d066246a | ||
|
|
b19dda8d5d | ||
|
|
0a7b50a730 | ||
|
|
bf82533028 | ||
|
|
0370750a3f | ||
|
|
ea88b06206 | ||
|
|
f1e3ed88ea | ||
|
|
ada41ec7dd | ||
|
|
1abff4937c | ||
|
|
cc1cd114e4 | ||
|
|
e86662561f | ||
|
|
059f93aee8 | ||
|
|
fc132f3a92 | ||
|
|
431242c926 | ||
|
|
0f9414847a | ||
|
|
86e04414ba | ||
|
|
c89b6bbe31 | ||
|
|
f6b8054669 | ||
|
|
4f4d05fe65 | ||
|
|
702e7b8972 | ||
|
|
d11deb3473 | ||
|
|
e2c63d6579 | ||
|
|
86871a6a55 | ||
|
|
923bafdc9b | ||
|
|
afc8945d78 | ||
|
|
610586f0d3 | ||
|
|
5a811421db | ||
|
|
c96b22bc5f | ||
|
|
21a967145f | ||
|
|
494aa29cdb | ||
|
|
02d4f797ca | ||
|
|
0158dbb54b | ||
|
|
4aff73305f | ||
|
|
f5bb9ce70e | ||
|
|
337e6c39c7 | ||
|
|
3136948453 | ||
|
|
c155ee7160 | ||
|
|
ff99ab3ff9 | ||
|
|
a40d9893fb | ||
|
|
ed78552a72 | ||
|
|
dd1d507d90 | ||
|
|
2ac6ee84df | ||
|
|
400a2be0fe | ||
|
|
65ff2ee22d | ||
|
|
f1ec7bbe8e | ||
|
|
f466271e15 | ||
|
|
d926ef7591 | ||
|
|
c9848bd6e4 | ||
|
|
8b0c8a3c18 | ||
|
|
bffe360c6d | ||
|
|
734fca7d4a | ||
|
|
5a2ae56991 | ||
|
|
d8a8bce272 | ||
|
|
517ae8ffc3 | ||
|
|
78cc54d3a8 | ||
|
|
c94ecf5ca7 | ||
|
|
4eab67a8db | ||
|
|
7dfc0e5fca | ||
|
|
61783e4c81 | ||
|
|
59642e51f1 | ||
|
|
dcb7258caf | ||
|
|
7ab6021630 | ||
|
|
c48b6a3704 | ||
|
|
a0467d52cd | ||
|
|
5589328a3c | ||
|
|
af2fc137d5 | ||
|
|
be35375387 | ||
|
|
d88b693e26 | ||
|
|
e8c3035254 | ||
|
|
aec024a943 | ||
|
|
49e8d887da | ||
|
|
ee67a746d4 | ||
|
|
72dadb3c76 | ||
|
|
e0cc8b4cd8 | ||
|
|
c792a6b794 | ||
|
|
129de37d3e | ||
|
|
77f0798c06 | ||
|
|
eb4c231c23 | ||
|
|
2da94f733d | ||
|
|
d136975154 | ||
|
|
411bf39c7d | ||
|
|
2f3fc21c84 | ||
|
|
4e85cb14c5 | ||
|
|
2da5d8bb7d | ||
|
|
4d4307ef57 | ||
|
|
fbfd7ad5f3 | ||
|
|
509b4dd232 | ||
|
|
877c45af90 | ||
|
|
bed41fa46c | ||
|
|
2be0dbbb2a | ||
|
|
710eb69e8c | ||
|
|
275b789ca9 | ||
|
|
18550cd297 | ||
|
|
15790f3028 | ||
|
|
3296323059 | ||
|
|
037763561e | ||
|
|
c84433352e | ||
|
|
c8c8c0eb03 | ||
|
|
a06b2c98a7 | ||
|
|
3cb387747b | ||
|
|
57fc00a45e | ||
|
|
ce52b26329 | ||
|
|
337d94823a | ||
|
|
288b701d4e | ||
|
|
c2372473d0 | ||
|
|
066c54b1d2 | ||
|
|
7432ef9bb9 | ||
|
|
fa24dcd29a | ||
|
|
bbaab0b8f8 | ||
|
|
81b9464f68 | ||
|
|
1b7fc0fc58 | ||
|
|
13e8dd86e5 | ||
|
|
06c0fd8566 | ||
|
|
cd6c23823c | ||
|
|
ff76f5d888 | ||
|
|
cc9863c95f | ||
|
|
59df1f995b | ||
|
|
f41d555b62 | ||
|
|
a69cfdac41 | ||
|
|
b6c5b69ffe | ||
|
|
8ce2de3631 | ||
|
|
ff957661e5 | ||
|
|
01b476b342 | ||
|
|
fbec1e2ecc | ||
|
|
00b5487cc0 | ||
|
|
fb2f4b2ee9 | ||
|
|
c67a748915 | ||
|
|
d24b501281 | ||
|
|
5d30a73bad | ||
|
|
659e96e780 | ||
|
|
2fe448c3d8 | ||
|
|
c295e645c5 | ||
|
|
ca434f9c05 | ||
|
|
0e8d635e44 | ||
|
|
6c9b280fa2 | ||
|
|
cb1c5e8748 | ||
|
|
e7be6327d4 | ||
|
|
d2c00026e6 | ||
|
|
ed280f9a33 | ||
|
|
f1e6d37dcf | ||
|
|
98f3eb0a72 | ||
|
|
82c714d0cc | ||
|
|
982ac3ec72 | ||
|
|
f99a76886e | ||
|
|
989ab72a58 | ||
|
|
5444bad439 | ||
|
|
7e00de835d | ||
|
|
620d0c2711 | ||
|
|
8d2d295a60 | ||
|
|
0fff06ec6b | ||
|
|
f4a8013388 | ||
|
|
15e0c95cb6 | ||
|
|
53327b3147 | ||
|
|
92a746f803 | ||
|
|
d4a85c40e6 | ||
|
|
8115fb225f | ||
|
|
8eb3b75a80 | ||
|
|
bdadb0fa8d | ||
|
|
90f3708e16 | ||
|
|
67a6658754 | ||
|
|
c1a82ad8ab | ||
|
|
6a39dcd6ec | ||
|
|
2778775565 | ||
|
|
8a22696a37 | ||
|
|
f0f19c2dae | ||
|
|
35264dc130 | ||
|
|
ccc2b5636e | ||
|
|
6360fa8ba0 | ||
|
|
bad798d90d | ||
|
|
b4c0936207 | ||
|
|
aee0caa5c8 | ||
|
|
b0b9f8cbee | ||
|
|
557c89acdd | ||
|
|
5352fd4f99 | ||
|
|
b206fc79b3 | ||
|
|
721cf7f321 | ||
|
|
abd84de68d | ||
|
|
7352358662 | ||
|
|
68adf50362 | ||
|
|
f2e6d335f0 | ||
|
|
ee462c9981 | ||
|
|
497da675b9 | ||
|
|
df5f75eb89 | ||
|
|
aef74c6e6a | ||
|
|
68371c2c05 | ||
|
|
cdbfef2d21 | ||
|
|
241c8367e3 | ||
|
|
b316840ea0 | ||
|
|
f1d26791fc | ||
|
|
5d0bce1242 | ||
|
|
0323409cd5 | ||
|
|
7b41882e6c | ||
|
|
38547e4ad2 | ||
|
|
c6541de1b5 | ||
|
|
76a08a2322 | ||
|
|
85ebb343ed | ||
|
|
d5021e549a | ||
|
|
4d1d469686 | ||
|
|
25aee5ed22 | ||
|
|
7b88125f5e | ||
|
|
55854f6652 | ||
|
|
e4c75c7354 | ||
|
|
7b4127b0f1 | ||
|
|
8af89c05cb | ||
|
|
233ac19914 | ||
|
|
6f111bce2e | ||
|
|
051452231a | ||
|
|
f943b025cb | ||
|
|
ee298ec362 | ||
|
|
803ed0933a | ||
|
|
b0c810a981 | ||
|
|
05cbed815f | ||
|
|
adef7ad06e | ||
|
|
226ca889b6 | ||
|
|
d8e9819e0a | ||
|
|
81dfe45b72 | ||
|
|
12f0970e39 | ||
|
|
73422e8da0 | ||
|
|
60719f03c7 | ||
|
|
5acb1a7ffe | ||
|
|
e93f365a0b | ||
|
|
4a182588b4 | ||
|
|
5b7b0a7b4e | ||
|
|
a032abc910 | ||
|
|
cf5906030a | ||
|
|
ac410507f2 | ||
|
|
2db9ee328c | ||
|
|
0728154751 | ||
|
|
b1404ada6d | ||
|
|
93a4246682 | ||
|
|
1b5287724e | ||
|
|
d17c97780e | ||
|
|
499f84be21 | ||
|
|
77e2b567e6 | ||
|
|
9f58bb22e3 | ||
|
|
3e6c3f589f | ||
|
|
9ac713f0e5 | ||
|
|
ce06214014 | ||
|
|
3f265888a4 | ||
|
|
550ea6da58 | ||
|
|
4d0e40f135 | ||
|
|
d45dd151b7 | ||
|
|
1827c1294b | ||
|
|
b3383b0396 | ||
|
|
2e555a1453 | ||
|
|
86af5d8724 | ||
|
|
1983a4bb64 | ||
|
|
45f9f0f21e | ||
|
|
6b378ffbf5 | ||
|
|
c443adbfca | ||
|
|
b56c15b64c | ||
|
|
2e8e9265d9 | ||
|
|
4ac973ba31 | ||
|
|
88d7caf013 | ||
|
|
ed1230d1cf | ||
|
|
59812a350f | ||
|
|
0b6ed62738 | ||
|
|
5adc5ffba0 | ||
|
|
e1f9cfb286 | ||
|
|
e204d4ff1b | ||
|
|
9f6565f097 | ||
|
|
b9f189b3f7 | ||
|
|
526bac39c2 | ||
|
|
253f379fd0 | ||
|
|
f14808b8a3 | ||
|
|
28e9cc01e5 | ||
|
|
bafc9b757f | ||
|
|
bcbdd05a6f | ||
|
|
8db7598141 | ||
|
|
24669cf58f | ||
|
|
937768651e | ||
|
|
182524baac | ||
|
|
f237b0942e | ||
|
|
56e6dbe8d8 | ||
|
|
ea3d031acc | ||
|
|
0f9b624124 | ||
|
|
4f31304a1a | ||
|
|
229171c7e3 | ||
|
|
999f6c3dbd |
|
|
@ -1,5 +1,6 @@
|
||||||
{;;:skip-comments true
|
{;;:skip-comments true
|
||||||
:lint-as {potemkin/def-derived-map clojure.core/defrecord}
|
:lint-as {potemkin/def-derived-map clojure.core/defrecord
|
||||||
|
clojure.test.check.clojure-test/defspec clojure.test/deftest}
|
||||||
:linters {:missing-else-branch {:level :off}
|
:linters {:missing-else-branch {:level :off}
|
||||||
:unused-binding {:level :off}
|
:unused-binding {:level :off}
|
||||||
:unused-referred-var {:exclude {clojure.test [deftest testing is are]
|
:unused-referred-var {:exclude {clojure.test [deftest testing is are]
|
||||||
|
|
|
||||||
26
.github/workflows/release.yml
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published # reacts to releases and prereleases, but not their drafts
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v5
|
||||||
|
- name: "Setup Java"
|
||||||
|
uses: actions/setup-java@v5
|
||||||
|
with:
|
||||||
|
distribution: zulu
|
||||||
|
java-version: 11
|
||||||
|
- name: "Setup Clojure"
|
||||||
|
uses: DeLaGuardo/setup-clojure@master
|
||||||
|
with:
|
||||||
|
lein: 2.9.5
|
||||||
|
- name: Deploy to Clojars
|
||||||
|
run: ./scripts/lein-modules do clean, deploy clojars
|
||||||
|
env:
|
||||||
|
CLOJARS_USERNAME: metosinci
|
||||||
|
CLOJARS_PASSWORD: "${{ secrets.CLOJARS_DEPLOY_TOKEN }}"
|
||||||
88
.github/workflows/testsuite.yml
vendored
|
|
@ -2,77 +2,117 @@ name: testsuite
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
branches: [master]
|
||||||
pull_request:
|
pull_request:
|
||||||
|
branches: [master]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-clj:
|
build-clj:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
# Supported Java versions: LTS releases 8 and 11 and the latest release
|
# Supported Java versions: LTS releases and latest
|
||||||
jdk: [8, 11, 15]
|
jdk: [11, 17, 21, 25]
|
||||||
|
clojure: [11, 12]
|
||||||
|
|
||||||
name: Clojure (Java ${{ matrix.jdk }})
|
name: Clojure ${{ matrix.clojure }} (Java ${{ matrix.jdk }})
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Cache dependencies
|
- name: Cache dependencies
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
path: ~/.m2/repository
|
path: ~/.m2/repository
|
||||||
key: ${{ runner.os }}-clj-${{ hashFiles('**/project.clj') }}
|
key: ${{ runner.os }}-clj-${{ hashFiles('**/project.clj') }}
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-clj-
|
${{ runner.os }}-clj-
|
||||||
|
|
||||||
- name: Setup Java ${{ matrix.jdk }}
|
- name: Setup Java ${{ matrix.jdk }}
|
||||||
uses: actions/setup-java@v1.4.3
|
uses: actions/setup-java@v4
|
||||||
with:
|
with:
|
||||||
|
distribution: temurin
|
||||||
java-version: ${{ matrix.jdk }}
|
java-version: ${{ matrix.jdk }}
|
||||||
|
|
||||||
- name: Setup Clojure
|
- name: Setup Clojure
|
||||||
uses: DeLaGuardo/setup-clojure@3.1
|
uses: DeLaGuardo/setup-clojure@13.1
|
||||||
with:
|
with:
|
||||||
lein: 2.9.5
|
lein: 2.9.5
|
||||||
|
clj-kondo: 2025.12.23
|
||||||
|
|
||||||
|
# Install openapi-schema-validator for openapi-tests
|
||||||
|
# Uses node version from the ubuntu-latest
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Run Linter
|
||||||
|
run: ./lint.sh
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: ./scripts/test.sh clj
|
run: ./scripts/test.sh clj${{ matrix.clojure }}
|
||||||
|
|
||||||
build-cljs:
|
build-cljs:
|
||||||
name: ClojureScript
|
name: ClojureScript
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Cache dependencies
|
- name: Cache dependencies
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.m2/repository
|
~/.m2/repository
|
||||||
**/node_modules
|
key: ${{ runner.os }}-cljs-${{ hashFiles('**/project.clj') }}
|
||||||
key: ${{ runner.os }}-cljs-${{ hashFiles('**/project.clj', '**/package-lock.json') }}
|
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-cljs-
|
${{ runner.os }}-cljs-
|
||||||
- name: Setup Java 11
|
|
||||||
uses: actions/setup-java@v1.4.3
|
- name: Setup Java
|
||||||
|
uses: actions/setup-java@v4
|
||||||
with:
|
with:
|
||||||
java-version: 11
|
distribution: temurin
|
||||||
|
java-version: 21
|
||||||
|
|
||||||
- name: Setup Clojure
|
- name: Setup Clojure
|
||||||
uses: DeLaGuardo/setup-clojure@3.1
|
uses: DeLaGuardo/setup-clojure@13.1
|
||||||
with:
|
with:
|
||||||
lein: 2.9.5
|
lein: 2.9.5
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
uses: actions/setup-node@v2.1.2
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 22
|
||||||
|
cache: npm
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: npm ci
|
||||||
npm ci
|
|
||||||
- name: Install modules
|
|
||||||
run: ./scripts/lein-modules install
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: ./scripts/test.sh cljs
|
run: ./scripts/test.sh cljs
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
name: Lint
|
name: Lint cljdoc.edn
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Verify cljdoc.edn
|
- name: Verify cljdoc.edn
|
||||||
run: curl -fsSL https://raw.githubusercontent.com/cljdoc/cljdoc/master/script/verify-cljdoc-edn | bash -s doc/cljdoc.edn
|
run: curl -fsSL https://raw.githubusercontent.com/cljdoc/cljdoc/master/script/verify-cljdoc-edn | bash -s doc/cljdoc.edn
|
||||||
|
|
||||||
|
check-cljdoc:
|
||||||
|
name: Check cljdoc analysis
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Clojure
|
||||||
|
uses: DeLaGuardo/setup-clojure@13.1
|
||||||
|
with:
|
||||||
|
lein: 2.9.5
|
||||||
|
cli: 1.11.0.1100
|
||||||
|
|
||||||
|
- name: Install cljdoc analyzer
|
||||||
|
run: clojure -Ttools install io.github.cljdoc/cljdoc-analyzer '{:git/tag "RELEASE"}' :as cljdoc-analyzer
|
||||||
|
|
||||||
|
- name: CljDoc Check
|
||||||
|
run: ./scripts/cljdoc-check.sh
|
||||||
|
|
|
||||||
2
.gitignore
vendored
|
|
@ -14,3 +14,5 @@ pom.xml.asc
|
||||||
figwheel_server.log
|
figwheel_server.log
|
||||||
/.idea
|
/.idea
|
||||||
.clj-kondo
|
.clj-kondo
|
||||||
|
.shadow-cljs
|
||||||
|
.cache
|
||||||
|
|
|
||||||
254
CHANGELOG.md
|
|
@ -12,8 +12,255 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
|
||||||
|
|
||||||
[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
|
[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
|
||||||
|
|
||||||
|
## UNRELEASED
|
||||||
|
|
||||||
|
* **FIX** redirect-trailing-slash-handler won't make external redirects. [#776](https://github.com/metosin/reitit/pull/776)
|
||||||
|
* Allow colons in bracket parameter syntax. [#770](https://github.com/metosin/reitit/pull/770)
|
||||||
|
* Add `url-encode?` option to `match-by-name`. [#778](https://github.com/metosin/reitit/pull/778)
|
||||||
|
|
||||||
|
## 0.10.0 (2026-01-09)
|
||||||
|
|
||||||
|
* Improve & document how response schemas get picked in per-content-type coercion. See [docs](./doc/ring/coercion.md#per-content-type-coercion). [#745](https://github.com/metosin/reitit/issues/745).
|
||||||
|
* **BREAKING** Remove unused `reitit.dependency` ns. [#763](https://github.com/metosin/reitit/pull/763)
|
||||||
|
* Support passing options to malli humanize. See [docs](./doc/coercion/malli_coercion.md). [#467](https://github.com/metosin/reitit/issues/467)
|
||||||
|
* **FIX** Handling of ex-type keyword hierarchies in create-exception-middleware. [#768](https://github.com/metosin/reitit/issues/768)
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
[metosin/malli "0.20.0"] is available but we use "0.19.2"
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.20.1"] is available but we use "2.20.0"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.20.1"] is available but we use "2.20.0"
|
||||||
|
[org.clojure/core.rrb-vector "0.2.1"] is available but we use "0.2.0"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.9.2 (2025-10-28)
|
||||||
|
|
||||||
|
* Allow multimethods as handlers when validating [#755](https://github.com/metosin/reitit/pull/755)
|
||||||
|
* Improve error reporting when generating OpenAPI fails [#754](https://github.com/metosin/reitit/pull/754)
|
||||||
|
* Allow middleware registry to be used when defining middleware in `ring-handler`. See [docs](./doc/ring/middleware_registry.md). [#739](https://github.com/metosin/reitit/pull/739)
|
||||||
|
* Allow passing options (eg. `:malli.transform/add-optional-keys`) to malli's `default-value-transformer`. See [docs](./doc/coercion/malli_coercion.md). [#756](https://github.com/metosin/reitit/pull/756)
|
||||||
|
* **FIX**: `match-by-name!` returning `nil` instead of throwing an exception for some partial matches [#758](https://github.com/metosin/reitit/issues/758)
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.20.0"] is available but we use "2.18.2"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.20.0"] is available but we use "2.18.2"
|
||||||
|
[compojure "1.7.2"] is available but we use "1.7.1"
|
||||||
|
[fipp "0.6.29"] is available but we use "0.6.27"
|
||||||
|
[metosin/malli "0.19.2"] is available but we use "0.18.0"
|
||||||
|
[ring "1.15.3"] is available but we use "1.14.1"
|
||||||
|
[ring/ring-core "1.15.3"] is available but we use "1.14.1"
|
||||||
|
[ring/ring-defaults "0.7.0"] is available but we use "0.6.0"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.9.1 (2025-05-27)
|
||||||
|
|
||||||
|
* **FIX**: response coercion threw an exception for unlisted HTTP status codes if there was no `:default`. Broken in 0.9.0. [#742](https://github.com/metosin/reitit/issues/742)
|
||||||
|
|
||||||
|
## 0.9.0 (2025-05-23)
|
||||||
|
|
||||||
|
* Improvements to mime type handling in `create-file-handler` and `create-resource-handler` [#733](https://github.com/metosin/reitit/pull/733)
|
||||||
|
* New `:mime-types` option to configure a map from file extension to mime type
|
||||||
|
* Don't set Content-Type header at all if mime type is not known
|
||||||
|
* Fix location of OpenAPI deprecated metadata [#714](https://github.com/metosin/reitit/pull/714)
|
||||||
|
* **BREAKING** Fix & clarify `:responses :default` and `:content :default` handling. See [docs](./doc/ring/coercion.md). [#735](https://github.com/metosin/reitit/pull/735)
|
||||||
|
* Summary: If `:responses <status>` is present, `:responses :default` is not used, even if `:responses <status>` defines no schema.
|
||||||
|
* Should not break normal use, but might cause surprises related to defaults applying/not applying
|
||||||
|
* **NOTE** This release depends on malli 0.18.0, which changes the format of OpenAPI & Swagger named schemas from `foo.bar/quux` to `foo.bar.quux`
|
||||||
|
|
||||||
|
## 0.8.0 (2025-03-28)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.2..0.8.0)**
|
||||||
|
|
||||||
|
* **BREAKING**: throw error if `:responses` keys are not integers [#667](https://github.com/metosin/reitit/issues/667)
|
||||||
|
* **BREAKING**: Java 8 is no longer supported (Ring-core requires Apache Commons FileUpload which now requires Java 11)
|
||||||
|
* File and resource handlers (`create-file-handler` and `create-resource-handler`)
|
||||||
|
* **BREAKING**: New default is to redirect from `dir` path to `dir/` and serve the index file (if found) on the path ending with `/`
|
||||||
|
* For example the Swagger UI handler now serves the index from `/api-docs/` instead of redirecting to `/api-docs/index.html` (both work)
|
||||||
|
* Mostly this is a visual change, though if you have unit tests checking for response status or redirect, those could break
|
||||||
|
* New option `:index-redirect?` (default false) allows enable redirecting to the index file, e.g. `dir` -> `dir/index.html` (same as the old default)
|
||||||
|
* New option `:canonicalize-uris?` (default true) enables redirect from `dir` to `dir/` if the index file exists for the path
|
||||||
|
* Without this option `dir` would return 404 and `dir/` and `dir/index.html` would return the file
|
||||||
|
* Changes in 0.8.0-alpha1
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
[fipp "0.6.27"] is available but we use "0.6.26"
|
||||||
|
[metosin/jsonista "0.3.13"] is available but we use "0.3.10"
|
||||||
|
[metosin/malli "0.17.0"] is available but we use "0.16.4"
|
||||||
|
[metosin/muuntaja "0.6.11"] is available but we use "0.6.10"
|
||||||
|
[metosin/ring-swagger-ui "5.20.0"] is available but we use "5.9.0"
|
||||||
|
[ring/ring-core "1.14.1"] is available but we use "1.12.2"
|
||||||
|
[ring/ring-defaults "0.6.0"] is available but we use "0.5.0"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.8.0-alpha1 (2025-01-31)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.2..0.8.0-alpha1)**
|
||||||
|
|
||||||
|
* Improve OpenAPI docs, plus don't emit `:description` in the wrong place [#702](https://github.com/metosin/reitit/pull/702)
|
||||||
|
* Support reitit.walk for all IPersitentMap implementations, fixes coercion with
|
||||||
|
aleph 0.7.2 [#700](https://github.com/metosin/reitit/issues/700), [#701](https://github.com/metosin/reitit/pull/701)
|
||||||
|
* *POTENTIALLY BREAKING* The frontend functions (href, push/replace-state, navigate, set-query) now
|
||||||
|
encode query-string values using configured coercion when possible (only Malli supports encoding).
|
||||||
|
[#716](https://github.com/metosin/reitit/pull/716)
|
||||||
|
- You can use this to encode query parameter values before they are URL-encoded. This works for DateTimes, collections etc.
|
||||||
|
- In most cases this shouldn't break existing uses, but it is possible even without
|
||||||
|
a custom encoding function, the default Malli string-transformer could encode some values differently
|
||||||
|
then previously.
|
||||||
|
|
||||||
|
## 0.7.2 (2024-09-02)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.1..0.7.2)**
|
||||||
|
|
||||||
|
* Speed up routes and inline it in code ring handler [#693](https://github.com/metosin/reitit/pull/693) [#693](https://github.com/metosin/reitit/pull/696)
|
||||||
|
* Fix: Can't get descendants of classes [#555](https://github.com/metosin/reitit/issues/555)
|
||||||
|
* Faster keywordize [#506](https://github.com/metosin/reitit/pull/506)
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```clojure
|
||||||
|
[metosin/jsonista "0.3.10"] is available but we use "0.3.9"
|
||||||
|
[metosin/malli "0.16.4"] is available but we use "0.16.2"
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.17.2"] is available but we use "2.17.1"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.17.2"] is available but we use "2.17.1"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.7.1 (2024-06-30)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0..0.7.1)**
|
||||||
|
|
||||||
|
* FIX: Route data maps ignore meta-merge options in 0.7.0, breaking compatibility [#679](https://github.com/metosin/reitit/issues/679)
|
||||||
|
* FIX: Clojure record in route data is converted to a plain map [#686](https://github.com/metosin/reitit/issues/686)
|
||||||
|
* Add arities 1 and 2 to rf/match->path [#685](https://github.com/metosin/reitit/pull/685)
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```clojure
|
||||||
|
[ring/ring-core "1.12.2"] is available but we use "1.12.1"
|
||||||
|
[metosin/malli "0.16.2"] is available but we use "0.16.1"
|
||||||
|
[metosin/jsonista "0.3.9"] is available but we use "0.3.8"
|
||||||
|
[metosin/spec-tools "0.10.7"] is available but we use "0.10.6"
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.17.1"] is available but we use "2.17.0"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.17.1"] is available but we use "2.17.0"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.7.0 (2024-04-30)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.6.0..0.7.0)**
|
||||||
|
|
||||||
|
The OpenAPI3 release, Year in the making - the changes span over multiple repositories.
|
||||||
|
|
||||||
|
* Openapi3 support, see the [docs](https://github.com/metosin/reitit/blob/master/doc/ring/openapi.md)
|
||||||
|
* Fetch OpenAPI content types from Muuntaja [#636](https://github.com/metosin/reitit/issues/636)
|
||||||
|
* OpenAPI 3 parameter descriptions get populated from malli/spec/schema descriptions. [#612](https://github.com/metosin/reitit/issues/612)
|
||||||
|
* Generate correct OpenAPI $ref schemas for malli var and ref schemas [#673](https://github.com/metosin/reitit/pull/673)
|
||||||
|
* new syntax for `:request` and `:response` per-content-type coercions. See [coercion.md](doc/ring/coercion.md). [#627](https://github.com/metosin/reitit/issues/627)
|
||||||
|
* [#84](https://github.com/metosin/reitit/issues/84)
|
||||||
|
* Handlers can be vars [#585](https://github.com/metosin/reitit/pull/585)
|
||||||
|
* Fix swagger generation when unsupported coercions are present [#671](https://github.com/metosin/reitit/pull/671)
|
||||||
|
* **BREAKING**: require Clojure 1.11, drop support for Clojure 1.10
|
||||||
|
* **BREAKING**: `compile-request-coercers` returns a map with `:data` and `:coerce` instead of plain `:coerce` function
|
||||||
|
* **BREAKING**: Parameter and Response schemas are merged into the route data vector - so they can be properly merged into the compiled result, fixes [#422](https://github.com/metosin/reitit/issues/422) - merging multiple schemas together works with `Malli` and `Schema`, partially with `data-spec` but not with `spec`.
|
||||||
|
* Fixed some module dependencies so Cljdoc can properly analyze all the modules
|
||||||
|
* Fix reading fragment string on `Html5History` initialization
|
||||||
|
* Add fragment string parameter to reitit-frontend functions ([#604](https://github.com/metosin/reitit/pull/604))
|
||||||
|
* Frontend: provide easy way to update current query params. [#600](https://github.com/metosin/reitit/issues/600)
|
||||||
|
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```clojure
|
||||||
|
[metosin/malli "0.16.1"] is available but we use "0.10.1"
|
||||||
|
[metosin/muuntaja "0.6.10"] is available but we use "0.6.8"
|
||||||
|
[metosin/spec-tools "0.10.6"] is available but we use "0.10.5"
|
||||||
|
[metosin/schema-tools "0.13.1"] is available but we use "0.13.0"
|
||||||
|
[metosin/jsonista "0.3.8"] is available but we use "0.3.7"
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.17.0"] is available but we use "2.14.2"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.17.0"] is available but we use "2.14.2"
|
||||||
|
[ring/ring-core "1.12.1"] is available but we use "1.9.6"
|
||||||
|
[metosin/ring-swagger-ui "5.9.0"] is available but we use "4.15.5"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.7.0-alpha8 (2024-04-30)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha7...0.7.0-alpha8)**
|
||||||
|
|
||||||
|
* Handlers can be vars [#585](https://github.com/metosin/reitit/pull/585)
|
||||||
|
* Fetch OpenAPI content types from Muuntaja [#636](https://github.com/metosin/reitit/issues/636)
|
||||||
|
* **BREAKING** OpenAPI support is now clj only
|
||||||
|
* Fix swagger generation when unsupported coercions are present [#671](https://github.com/metosin/reitit/pull/671)
|
||||||
|
* Generate correct OpenAPI $ref schemas for malli var and ref schemas [#673](https://github.com/metosin/reitit/pull/673)
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```clojure
|
||||||
|
[metosin/malli "0.16.1"] is available but we use "0.13.0"
|
||||||
|
[metosin/muuntaja "0.6.10"] is available but we use "0.6.8"
|
||||||
|
[metosin/spec-tools "0.10.6"] is available but we use "0.10.5"
|
||||||
|
[metosin/jsonista "0.3.8"] is available but we use "0.3.7"
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.17.0"] is available but we use "2.15.1"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.17.0"] is available but we use "2.15.1"
|
||||||
|
[ring/ring-core "1.12.1"] is available but we use "1.10.0"
|
||||||
|
[metosin/ring-swagger-ui "5.9.0"] is available but we use "4.19.1"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.7.0-alpha7 (2023-10-03)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha6...0.7.0-alpha7)**
|
||||||
|
|
||||||
|
* Revert the group id change from alpha6
|
||||||
|
* New release to bring alpha6 changes to the old group id
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```clojure
|
||||||
|
[metosin/ring-swagger-ui "4.19.1"] is available but we use "4.18.1"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.7.0-alpha6 (2023-09-11)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha5...0.7.0-alpha6)**
|
||||||
|
|
||||||
|
* **BREAKING**: require Clojure 1.11, drop support for Clojure 1.10
|
||||||
|
* **BREAKING**: new syntax for `:request` and `:response` per-content-type coercions. See [coercion.md](doc/ring/coercion.md). [#627](https://github.com/metosin/reitit/issues/627)
|
||||||
|
* **BREAKING**: replace the openapi `:content-types` keyword with separate `:openapi/request-content-types` and `:openapi/response-content-types`. See [openapi.md](doc/ring/openapi.md)
|
||||||
|
* **NOTE!**: all reitit libraries are now under the `fi.metosin` group on clojars instead of `metosin`. Use `fi.metosin/reitit` in your dependencies instead of `metosin/reitit` to get new versions.
|
||||||
|
- **Reverted in alpha7 due to problems with renaming artifacts**
|
||||||
|
|
||||||
|
## 0.7.0-alpha5 (2023-06-14)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha4...0.7.0-alpha5)**
|
||||||
|
|
||||||
|
* **BREAKING**: `compile-request-coercers` returns a map with `:data` and `:coerce` instead of plain `:coerce` function
|
||||||
|
* **BREAKING**: Parameter and Response schemas are merged into the route data vector - so they can be properly merged into the compiled result, fixes [#422](https://github.com/metosin/reitit/issues/422) - merging multiple schemas together works with `Malli` and `Schema`, partially with `data-spec` but not with `spec`.
|
||||||
|
* Fixed some module dependencies so Cljdoc can properly analyze all the modules
|
||||||
|
* Updated dependencies:
|
||||||
|
|
||||||
|
```clojure
|
||||||
|
[metosin/schema-tools "0.13.1"] is available but we use "0.13.0"
|
||||||
|
[com.fasterxml.jackson.core/jackson-core "2.15.1"] is available but we use "2.14.2"
|
||||||
|
[com.fasterxml.jackson.core/jackson-databind "2.15.1"] is available but we use "2.14.2"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 0.7.0-alpha4 (2023-05-17)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha3...0.7.0-alpha4)**
|
||||||
|
|
||||||
|
* OpenAPI 3 parameter descriptions get populated from malli/spec/schema descriptions. [#612](https://github.com/metosin/reitit/issues/612)
|
||||||
|
|
||||||
|
## 0.7.0-alpha3 (2023-05-05)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha2...0.7.0-alpha3)**
|
||||||
|
|
||||||
|
* Compile `reitit.Trie` with Java 1.8 target for compatibility
|
||||||
|
|
||||||
|
## 0.7.0-alpha2 (2023-05-04)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.7.0-alpha1...0.7.0-alpha2)**
|
||||||
|
|
||||||
|
* Fix reading fragment string on `Html5History` initialization
|
||||||
|
* Add fragment string parameter to reitit-frontend functions ([#604](https://github.com/metosin/reitit/pull/604))
|
||||||
|
|
||||||
## 0.7.0-alpha1 (2023-05-03)
|
## 0.7.0-alpha1 (2023-05-03)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.6.0...0.7.0-alpha1)**
|
||||||
|
|
||||||
* Initial Openapi3 support. See [docs](./doc/ring/openapi.md). Works for simple cases but might still have some rough edges. [#84](https://github.com/metosin/reitit/issues/84)
|
* Initial Openapi3 support. See [docs](./doc/ring/openapi.md). Works for simple cases but might still have some rough edges. [#84](https://github.com/metosin/reitit/issues/84)
|
||||||
* Frontend: provide easy way to update current query params. [#600](https://github.com/metosin/reitit/issues/600)
|
* Frontend: provide easy way to update current query params. [#600](https://github.com/metosin/reitit/issues/600)
|
||||||
* Updated dependencies:
|
* Updated dependencies:
|
||||||
|
|
@ -26,6 +273,8 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
|
||||||
|
|
||||||
## 0.6.0 (2023-02-21)
|
## 0.6.0 (2023-02-21)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.5.18...0.6.0)**
|
||||||
|
|
||||||
* Add reitit-frontend support for fragment string [#581](https://github.com/metosin/reitit/pull/581)
|
* Add reitit-frontend support for fragment string [#581](https://github.com/metosin/reitit/pull/581)
|
||||||
* reloading-ring-handler [#584](https://github.com/metosin/reitit/pull/584)
|
* reloading-ring-handler [#584](https://github.com/metosin/reitit/pull/584)
|
||||||
* Remove redundant s/and [#552](https://github.com/metosin/reitit/pull/552)
|
* Remove redundant s/and [#552](https://github.com/metosin/reitit/pull/552)
|
||||||
|
|
@ -53,6 +302,8 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
|
||||||
|
|
||||||
## 0.5.18 (2022-04-05)
|
## 0.5.18 (2022-04-05)
|
||||||
|
|
||||||
|
**[compare](https://github.com/metosin/reitit/compare/0.5.17...0.5.18)**
|
||||||
|
|
||||||
* FIX [#334](https://github.com/metosin/reitit/pull/334) - Frontend: there is no way to catch the exception if coercion fails (via [#549](https://github.com/metosin/reitit/pull/549))
|
* FIX [#334](https://github.com/metosin/reitit/pull/334) - Frontend: there is no way to catch the exception if coercion fails (via [#549](https://github.com/metosin/reitit/pull/549))
|
||||||
* Save three seq constructions [#537](https://github.com/metosin/reitit/pull/537)
|
* Save three seq constructions [#537](https://github.com/metosin/reitit/pull/537)
|
||||||
* update jackson-databind for CVE-2020-36518 [#544](https://github.com/metosin/reitit/pull/544)
|
* update jackson-databind for CVE-2020-36518 [#544](https://github.com/metosin/reitit/pull/544)
|
||||||
|
|
@ -60,8 +311,9 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
|
||||||
|
|
||||||
## 0.5.17 (2022-03-10)
|
## 0.5.17 (2022-03-10)
|
||||||
|
|
||||||
* FIX match-by-path is broken if there are no non-conflicting wildcard routes [#538](https://github.com/metosin/reitit/issues/538)
|
**[compare](https://github.com/metosin/reitit/compare/0.5.16...0.5.17)**
|
||||||
|
|
||||||
|
* FIX match-by-path is broken if there are no non-conflicting wildcard routes [#538](https://github.com/metosin/reitit/issues/538)
|
||||||
|
|
||||||
## 0.5.16 (2022-02-15)
|
## 0.5.16 (2022-02-15)
|
||||||
|
|
||||||
|
|
|
||||||
10
Justfile
|
|
@ -1,10 +0,0 @@
|
||||||
help:
|
|
||||||
@just --list
|
|
||||||
|
|
||||||
# Initializes lint
|
|
||||||
init-lint:
|
|
||||||
clj-kondo --lint $(lein classpath)
|
|
||||||
|
|
||||||
# Lints the project
|
|
||||||
lint:
|
|
||||||
./lint.sh
|
|
||||||
99
README.md
|
|
@ -1,5 +1,11 @@
|
||||||
# reitit [](https://github.com/metosin/reitit/actions?query=workflow%3Atestsuite) [](https://cljdoc.org/jump/release/metosin/reitit) [](https://clojurians.slack.com/messages/reitit/)
|
# reitit
|
||||||
|
|
||||||
|
[](https://github.com/metosin/reitit/actions)
|
||||||
|
[](https://cljdoc.org/d/metosin/reitit/)
|
||||||
|
[](https://clojars.org/metosin/reitit)
|
||||||
|
[](https://clojurians.slack.com/messages/reitit/)
|
||||||
|
|
||||||
|
<img src="https://github.com/metosin/reitit/blob/master/doc/images/reitit.png?raw=true" align="right" width="200" />
|
||||||
A fast data-driven router for Clojure(Script).
|
A fast data-driven router for Clojure(Script).
|
||||||
|
|
||||||
* Simple data-driven [route syntax](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/basics/route-syntax/)
|
* Simple data-driven [route syntax](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/basics/route-syntax/)
|
||||||
|
|
@ -22,26 +28,34 @@ Presentations:
|
||||||
|
|
||||||
**Status:** [stable](https://github.com/metosin/open-source#project-lifecycle-model)
|
**Status:** [stable](https://github.com/metosin/open-source#project-lifecycle-model)
|
||||||
|
|
||||||
|
> Hi! We are [Metosin](https://metosin.fi), a consulting company. These libraries have evolved out of the work we do for our clients.
|
||||||
|
> We maintain & develop this project, for you, for free. Issues and pull requests welcome!
|
||||||
|
> However, if you want more help using the libraries, or want us to build something as cool for you, consider our [commercial support](https://www.metosin.fi/en/open-source-support).
|
||||||
|
|
||||||
## [Full Documentation](https://cljdoc.org/d/metosin/reitit/CURRENT)
|
## [Full Documentation](https://cljdoc.org/d/metosin/reitit/CURRENT)
|
||||||
|
|
||||||
There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians Slack](http://clojurians.net/) for discussion & help.
|
There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians Slack](http://clojurians.net/) for discussion & help.
|
||||||
|
|
||||||
## Main Modules
|
## Main Modules
|
||||||
|
|
||||||
* `reitit` - all bundled
|
* `metosin/reitit` - all bundled
|
||||||
* `reitit-core` - the routing core
|
* `metosin/reitit-core` - the routing core
|
||||||
* `reitit-ring` - a [ring router](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/ring/)
|
* `metosin/reitit-ring` - a [ring router](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/ring-router/)
|
||||||
* `reitit-middleware` - [common middleware](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/default-middleware/)
|
* `metosin/reitit-middleware` - [common middleware](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/default-middleware/)
|
||||||
* `reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion
|
* `metosin/reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion
|
||||||
* `reitit-malli` [malli](https://github.com/metosin/malli) coercion
|
* `metosin/reitit-malli` [malli](https://github.com/metosin/malli) coercion
|
||||||
* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
* `metosin/reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
||||||
* `reitit-swagger` [Swagger2](https://swagger.io/) apidocs
|
* `fi.metosin/reitit-openapi` [OpenAPI](https://www.openapis.org/) apidocs *
|
||||||
* `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui)
|
* `metosin/reitit-swagger` [Swagger2](https://swagger.io/) apidocs
|
||||||
* `reitit-frontend` Tools for [frontend routing]((https://cljdoc.org/d/metosin/reitit/CURRENT/doc/frontend/basics/))
|
* `metosin/reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui)
|
||||||
* `reitit-http` http-routing with Interceptors
|
* `metosin/reitit-frontend` Tools for [frontend routing]((https://cljdoc.org/d/metosin/reitit/CURRENT/doc/frontend/basics/))
|
||||||
* `reitit-interceptors` - [common interceptors](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/http/default-interceptors/)
|
* `metosin/reitit-http` http-routing with Interceptors
|
||||||
* `reitit-sieppari` support for [Sieppari](https://github.com/metosin/sieppari)
|
* `metosin/reitit-interceptors` - [common interceptors](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/http/default-interceptors/)
|
||||||
* `reitit-dev` - development utilities
|
* `metosin/reitit-sieppari` support for [Sieppari](https://github.com/metosin/sieppari)
|
||||||
|
* `metosin/reitit-dev` - development utilities
|
||||||
|
|
||||||
|
... * This is not a typo; the new `reitit-openapi` was released under the new, verified `fi.metosin` group. Existing
|
||||||
|
modules will continue to be released under `metosin` for compatibility purposes.
|
||||||
|
|
||||||
## Extra modules
|
## Extra modules
|
||||||
|
|
||||||
|
|
@ -52,11 +66,15 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
|
||||||
All main modules bundled:
|
All main modules bundled:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Optionally, the parts can be required separately.
|
Optionally, the parts can be required separately.
|
||||||
|
|
||||||
|
Reitit requires Clojure 1.11 and Java 11.
|
||||||
|
|
||||||
|
Reitit is tested with the LTS releases Java 11, 17, 21 and 25
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
|
|
@ -91,6 +109,7 @@ A Ring routing app with input & output coercion using [data-specs](https://githu
|
||||||
(require '[reitit.ring :as ring])
|
(require '[reitit.ring :as ring])
|
||||||
(require '[reitit.coercion.spec])
|
(require '[reitit.coercion.spec])
|
||||||
(require '[reitit.ring.coercion :as rrc])
|
(require '[reitit.ring.coercion :as rrc])
|
||||||
|
(require '[reitit.ring.middleware.exception :as exception])
|
||||||
(require '[reitit.ring.middleware.muuntaja :as muuntaja])
|
(require '[reitit.ring.middleware.muuntaja :as muuntaja])
|
||||||
(require '[reitit.ring.middleware.parameters :as parameters])
|
(require '[reitit.ring.middleware.parameters :as parameters])
|
||||||
|
|
||||||
|
|
@ -106,44 +125,50 @@ A Ring routing app with input & output coercion using [data-specs](https://githu
|
||||||
;; router data affecting all routes
|
;; router data affecting all routes
|
||||||
{:data {:coercion reitit.coercion.spec/coercion
|
{:data {:coercion reitit.coercion.spec/coercion
|
||||||
:muuntaja m/instance
|
:muuntaja m/instance
|
||||||
:middleware [parameters/parameters-middleware
|
:middleware [parameters/parameters-middleware ; decoding query & form params
|
||||||
|
muuntaja/format-middleware ; content negotiation
|
||||||
|
exception/exception-middleware ; converting exceptions to HTTP responses
|
||||||
rrc/coerce-request-middleware
|
rrc/coerce-request-middleware
|
||||||
muuntaja/format-response-middleware
|
|
||||||
rrc/coerce-response-middleware]}})))
|
rrc/coerce-response-middleware]}})))
|
||||||
```
|
```
|
||||||
|
|
||||||
Valid request:
|
Valid request:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
(app {:request-method :get
|
(-> (app {:request-method :get
|
||||||
:uri "/api/math"
|
:uri "/api/math"
|
||||||
:query-params {:x "1", :y "2"}})
|
:query-params {:x "1", :y "2"}})
|
||||||
|
(update :body slurp))
|
||||||
; {:status 200
|
; {:status 200
|
||||||
; :body {:total 3}}
|
; :body "{\"total\":3}"
|
||||||
|
; :headers {"Content-Type" "application/json; charset=utf-8"}}
|
||||||
```
|
```
|
||||||
|
|
||||||
Invalid request:
|
Invalid request:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
(app {:request-method :get
|
(-> (app {:request-method :get
|
||||||
:uri "/api/math"
|
:uri "/api/math"
|
||||||
:query-params {:x "1", :y "a"}})
|
:query-params {:x "1", :y "a"}})
|
||||||
;{:status 400,
|
(update :body jsonista.core/read-value))
|
||||||
; :body {:type :reitit.coercion/request-coercion,
|
; {:status 400
|
||||||
; :coercion :spec,
|
; :headers {"Content-Type" "application/json; charset=utf-8"}
|
||||||
; :spec "(spec-tools.core/spec {:spec (clojure.spec.alpha/keys :req-un [:$spec20745/x :$spec20745/y]), :type :map, :keys #{:y :x}, :keys/req #{:y :x}})",
|
; :body {"spec" "(spec-tools.core/spec {:spec (clojure.spec.alpha/keys :req-un [:spec$8974/x :spec$8974/y]), :type :map, :leaf? false})"
|
||||||
; :problems [{:path [:y],
|
; "value" {"x" "1"
|
||||||
; :pred "clojure.core/int?",
|
; "y" "a"}
|
||||||
; :val "a",
|
; "problems" [{"via" ["spec$8974/y"]
|
||||||
; :via [:$spec20745/y],
|
; "path" ["y"]
|
||||||
; :in [:y]}],
|
; "pred" "clojure.core/int?"
|
||||||
; :value {:x "1", :y "a"},
|
; "in" ["y"]
|
||||||
; :in [:request :query-params]}}
|
; "val" "a"}]
|
||||||
|
; "type" "reitit.coercion/request-coercion"
|
||||||
|
; "coercion" "spec"
|
||||||
|
; "in" ["request" "query-params"]}}
|
||||||
```
|
```
|
||||||
|
|
||||||
## More examples
|
## More examples
|
||||||
|
|
||||||
* [`reitit-ring` with coercion, swagger and default middleware](https://github.com/metosin/reitit/blob/master/examples/ring-swagger/src/example/server.clj)
|
* [`reitit-ring` with coercion, swagger and default middleware](https://github.com/metosin/reitit/blob/master/examples/ring-malli-swagger/src/example/server.clj)
|
||||||
* [`reitit-frontend`, the easy way](https://github.com/metosin/reitit/blob/master/examples/frontend/src/frontend/core.cljs)
|
* [`reitit-frontend`, the easy way](https://github.com/metosin/reitit/blob/master/examples/frontend/src/frontend/core.cljs)
|
||||||
* [`reitit-frontend` with Keechma-style controllers](https://github.com/metosin/reitit/blob/master/examples/frontend-controllers/src/frontend/core.cljs)
|
* [`reitit-frontend` with Keechma-style controllers](https://github.com/metosin/reitit/blob/master/examples/frontend-controllers/src/frontend/core.cljs)
|
||||||
* [`reitit-http` with Pedestal](https://github.com/metosin/reitit/blob/master/examples/pedestal/src/example/server.clj)
|
* [`reitit-http` with Pedestal](https://github.com/metosin/reitit/blob/master/examples/pedestal/src/example/server.clj)
|
||||||
|
|
|
||||||
26
bb.edn
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
{:tasks
|
||||||
|
{init-lint {:task (shell "sh -c" "clj-kondo --copy-configs --lint $(lein classpath)")}
|
||||||
|
lint {:doc "Run clj-kondo"
|
||||||
|
:task (shell "./lint.sh")}
|
||||||
|
|
||||||
|
watch-node-test {:doc "Watch files for changes and run Cljs tests on Node.js"
|
||||||
|
:task (shell "npx shadow-cljs watch node-test")}
|
||||||
|
node-test {:doc "Compile and run Cljs tests"
|
||||||
|
:task (shell "npx shadow-cljs compile node-test")}
|
||||||
|
|
||||||
|
watch-browser-test-local {:doc "Start watching Cljs tests for changes and start HTTP server for running tests in a local browser"
|
||||||
|
:task (shell "npx shadow-cljs watch browser-test")}
|
||||||
|
|
||||||
|
;; Karma watch needs to file to exist before start
|
||||||
|
-karma-placeholder (shell "sh -c" "mkdir -p target/karma && touch target/karma/ci.js")
|
||||||
|
-watch-karma-cljs {:depends [-karma-placeholder]
|
||||||
|
:task (shell "npx shadow-cljs watch karma")}
|
||||||
|
-watch-karma-test (shell "npx karma start")
|
||||||
|
-watch-karma {:depends [-watch-karma-cljs -watch-karma-test]}
|
||||||
|
watch-karma {:doc "Watch Cljs tests for changes, compile for Karma and run Karma tests on changes"
|
||||||
|
:task (run '-watch-karma {:parallel true})}
|
||||||
|
|
||||||
|
test-karma {:doc "Compile Cljs tests and run using Karma once"
|
||||||
|
:task (do
|
||||||
|
(shell "npx shadow-cljs compile karma")
|
||||||
|
(shell "npx karma start --single-run"))}}}
|
||||||
3
dev-resources/public/site.webmanifest
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
{
|
||||||
|
"name": "Example"
|
||||||
|
}
|
||||||
|
|
@ -24,6 +24,7 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
|
||||||
* `reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion
|
* `reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion
|
||||||
* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
||||||
* `reitit-swagger` [Swagger2](https://swagger.io/) apidocs
|
* `reitit-swagger` [Swagger2](https://swagger.io/) apidocs
|
||||||
|
* `reitit-openapi` OpenAPI 3 apidocs
|
||||||
* `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui).
|
* `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui).
|
||||||
* `reitit-frontend` Tools for [frontend routing](frontend/basics.md)
|
* `reitit-frontend` Tools for [frontend routing](frontend/basics.md)
|
||||||
* `reitit-http` http-routing with Pedestal-style Interceptors
|
* `reitit-http` http-routing with Pedestal-style Interceptors
|
||||||
|
|
@ -40,7 +41,7 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
|
||||||
All bundled:
|
All bundled:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Optionally, the parts can be required separately.
|
Optionally, the parts can be required separately.
|
||||||
|
|
|
||||||
|
|
@ -2,18 +2,21 @@
|
||||||
|
|
||||||
Routers can be configured via options. The following options are available for the `reitit.core/router`:
|
Routers can be configured via options. The following options are available for the `reitit.core/router`:
|
||||||
|
|
||||||
| key | description
|
| key | description
|
||||||
|---------------|-------------
|
|-----------------|-------------
|
||||||
| `:path` | Base-path for routes
|
| `:path` | Base-path for routes
|
||||||
| `:routes` | Initial resolved routes (default `[]`)
|
| `:routes` | Initial resolved routes (default `[]`)
|
||||||
| `:data` | Initial route data (default `{}`)
|
| `:data` | Initial route data (default `{}`)
|
||||||
| `:spec` | clojure.spec definition for a route data, see `reitit.spec` on how to use this
|
| `:spec` | clojure.spec definition for a route data, see `reitit.spec` on how to use this
|
||||||
| `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon})
|
| `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon})
|
||||||
| `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`)
|
| `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`)
|
||||||
| `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil`
|
| `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil`
|
||||||
| `:meta-merge` | Function which follows the signature of `meta-merge.core/meta-merge`, useful for when you want to have more control over the meta merging
|
| `:compile` | Function of `route opts => result` to compile a route handler
|
||||||
| `:compile` | Function of `route opts => result` to compile a route handler
|
| `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects
|
||||||
| `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects
|
| `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes
|
||||||
| `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes
|
| `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`)
|
||||||
| `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`)
|
| `:meta-merge` | Function of `left right => merged` to merge route-data (default `meta-merge.core/meta-merge`)
|
||||||
| `:router` | Function of `routes opts => router` to override the actual router implementation
|
| `:update-paths` | Sequence of Vectors with elements `update-path` and `function`, used to preprocess route data
|
||||||
|
| `:router` | Function of `routes opts => router` to override the actual router implementation
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -147,3 +147,19 @@ Let's apply a small change to our ```ns3```. We'll replace our router by two dif
|
||||||
|
|
||||||
And there you have it, dynamic during dev, performance at production. We have it all !
|
And there you have it, dynamic during dev, performance at production. We have it all !
|
||||||
|
|
||||||
|
## Var handlers
|
||||||
|
|
||||||
|
You can use a var instead of a function as a `:handler`. This will
|
||||||
|
allow you to modify the handler function without rebuilding the reitit
|
||||||
|
router.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(def router
|
||||||
|
(ring/router
|
||||||
|
["/ping" {:get #'my-ns/handler}]))
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you can reload `my-ns` or redefine `my-ns/handler` and the router
|
||||||
|
will use the new definition automatically.
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@ The default exception formatting uses `reitit.exception/exception`. It produces
|
||||||
## Pretty Errors
|
## Pretty Errors
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-dev "0.7.0-alpha1"]
|
[metosin/reitit-dev "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
For human-readable and developer-friendly exception messages, there is `reitit.dev.pretty/exception` (in the `reitit-dev` module). It is inspired by the lovely errors messages of [ELM](https://elm-lang.org/blog/compiler-errors-for-humans) and [ETA](https://twitter.com/jyothsnasrin/status/1037703436043603968) and uses [fipp](https://github.com/brandonbloom/fipp), [expound](https://github.com/bhb/expound) and [spell-spec](https://github.com/bhauman/spell-spec) for most of heavy lifting.
|
For human-readable and developer-friendly exception messages, there is `reitit.dev.pretty/exception` (in the `reitit-dev` module). It is inspired by the lovely errors messages of [ELM](https://elm-lang.org/blog/compiler-errors-for-humans) and [ETA](https://twitter.com/jyothsnasrin/status/1037703436043603968) and uses [fipp](https://github.com/brandonbloom/fipp), [expound](https://github.com/bhb/expound) and [spell-spec](https://github.com/bhauman/spell-spec) for most of heavy lifting.
|
||||||
|
|
|
||||||
|
|
@ -75,6 +75,17 @@ Path-parameters are automatically coerced into strings, with the help of (curren
|
||||||
; :path-params {:id "1"}}
|
; :path-params {:id "1"}}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
In case you want to do something like generate a template path for documentation, you can disable url-encoding:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(r/match-by-name router ::user {:id "<id goes here>"} {:url-encode? false})
|
||||||
|
; #reitit.core.Match{:template "/api/user/:id"
|
||||||
|
; :data {:name :user/user}
|
||||||
|
; :path "/api/user/<id goes here>"
|
||||||
|
; :result nil
|
||||||
|
; :path-params {:id "<id goes here>"}}
|
||||||
|
```
|
||||||
|
|
||||||
There is also an exception throwing version:
|
There is also an exception throwing version:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
|
|
@ -97,5 +108,5 @@ It can take an optional map of query-parameters too:
|
||||||
(-> router
|
(-> router
|
||||||
(r/match-by-name ::user {:id 1})
|
(r/match-by-name ::user {:id 1})
|
||||||
(r/match->path {:iso "möly"}))
|
(r/match->path {:iso "möly"}))
|
||||||
; "/api/user/1?iso=m%C3%B6ly"
|
; "/api/user/1?iso=m%C3%B6ly"
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -9,9 +9,10 @@ Route data is the key feature of reitit. Routes can have any map-like data attac
|
||||||
:handler identity}}]]
|
:handler identity}}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
Besides map-like data, raw routes can have any non-sequential route argument after the path. This argument is expanded by `Router` (via `:expand` option) into route data at router creation time.
|
Besides map-like data, raw routes can have any non-sequential route argument after the path. This argument is expanded by `Router` (via `:expand` option) into route data at router creation time.
|
||||||
|
|
||||||
By default, Keywords are expanded into `:name` and functions into `:handler` keys.
|
By default, Keywords are expanded into `:name` (see [Name-based Routing](./name_based_routing.md))
|
||||||
|
and functions into `:handler` keys.
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
(require '[reitit.core :as r])
|
(require '[reitit.core :as r])
|
||||||
|
|
@ -84,6 +85,8 @@ Resolved route tree:
|
||||||
; :roles #{:db-admin}}]]
|
; :roles #{:db-admin}}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See also [nested parameter definitions for coercions](../ring/coercion.md#nested-parameter-definitions)
|
||||||
|
|
||||||
## Route Data Fragments
|
## Route Data Fragments
|
||||||
|
|
||||||
Just like [fragments in React.js](https://reactjs.org/docs/fragments.html), we can create routing tree fragments by using empty path `""`. This allows us to add route data without accumulating to path.
|
Just like [fragments in React.js](https://reactjs.org/docs/fragments.html), we can create routing tree fragments by using empty path `""`. This allows us to add route data without accumulating to path.
|
||||||
|
|
@ -117,7 +120,7 @@ Accumulated route data:
|
||||||
["/api-docs" ::api-docs]]
|
["/api-docs" ::api-docs]]
|
||||||
["/api/ping" ::ping]
|
["/api/ping" ::ping]
|
||||||
["/api/pong" ::pong]]))
|
["/api/pong" ::pong]]))
|
||||||
|
|
||||||
(r/routes router)
|
(r/routes router)
|
||||||
; [["/swagger.json" {:no-doc true, :name ::swagger}]
|
; [["/swagger.json" {:no-doc true, :name ::swagger}]
|
||||||
; ["/api-docs" {:no-doc true, :name ::api-docs}]
|
; ["/api-docs" {:no-doc true, :name ::api-docs}]
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,9 @@
|
||||||
# Route Syntax
|
# Route Syntax
|
||||||
|
|
||||||
Routes are defined as vectors of String path and optional (non-sequential) route argument child routes.
|
Routes are defined as vectors of:
|
||||||
|
- path (a string)
|
||||||
|
- optional route data: usually a map, but see [Route Data](./route_data.md)
|
||||||
|
- any number of child routes
|
||||||
|
|
||||||
Routes can be wrapped in vectors and lists and `nil` routes are ignored.
|
Routes can be wrapped in vectors and lists and `nil` routes are ignored.
|
||||||
|
|
||||||
|
|
@ -11,43 +14,38 @@ Paths can have path-parameters (`:id`) or catch-all-parameters (`*path`). Parame
|
||||||
Simple route:
|
Simple route:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
["/ping"]
|
["/ping" {:handler ping}]
|
||||||
```
|
```
|
||||||
|
|
||||||
Two routes:
|
Two routes with more data:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["/ping"]
|
[["/ping" {:handler ping
|
||||||
["/pong"]]
|
:cost 300}]
|
||||||
|
["/pong" {:handler pong
|
||||||
|
:tags #{:game}}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
Routes with route arguments:
|
Routes with path parameters (see also [Coercion](../coercion/coercion.md) and [Ring Coercion](../ring/coercion.md)):
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["/ping" ::ping]
|
[["/users/:user-id" {:handler get-user}]
|
||||||
["/pong" {:name ::pong}]]
|
["/api/:version/ping" {:handler ping-version}]]
|
||||||
```
|
|
||||||
|
|
||||||
Routes with path parameters:
|
|
||||||
|
|
||||||
```clj
|
|
||||||
[["/users/:user-id"]
|
|
||||||
["/api/:version/ping"]]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["/users/{user-id}"]
|
[["/users/{user-id}" {:handler get-user}]
|
||||||
["/files/file-{number}.pdf"]]
|
["/files/file-{number}.pdf" {:handler get-pdf}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
Route with catch-all parameter:
|
Route with catch-all parameter:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
["/public/*path"]
|
["/public/*path" {:handler get-file}]
|
||||||
```
|
```
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
["/public/{*path}"]
|
["/public/{*path}" {:handler get-file}]
|
||||||
```
|
```
|
||||||
|
|
||||||
Nested routes:
|
Nested routes:
|
||||||
|
|
@ -55,9 +53,9 @@ Nested routes:
|
||||||
```clj
|
```clj
|
||||||
["/api"
|
["/api"
|
||||||
["/admin" {:middleware [::admin]}
|
["/admin" {:middleware [::admin]}
|
||||||
["" ::admin]
|
["" {:name ::admin}]
|
||||||
["/db" ::db]]
|
["/db" {:name ::db}]]
|
||||||
["/ping" ::ping]]
|
["/ping" {:name ::ping}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
Same routes flattened:
|
Same routes flattened:
|
||||||
|
|
@ -77,31 +75,31 @@ Reitit does not apply any encoding to your paths. If you need that, you must enc
|
||||||
Normal path-parameters (`:id`) can start anywhere in the path string, but have to end either to slash `/` (currently hardcoded) or to an end of path string:
|
Normal path-parameters (`:id`) can start anywhere in the path string, but have to end either to slash `/` (currently hardcoded) or to an end of path string:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["/api/:version"]
|
[["/api/:version" {...}]
|
||||||
["/files/file-:number"]
|
["/files/file-:number" {...}]
|
||||||
["/user/:user-id/orders"]]
|
["/user/:user-id/orders" {...}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
Bracket path-parameters can start and stop anywhere in the path-string, the following character is used as a terminator.
|
Bracket path-parameters can start and stop anywhere in the path-string, the following character is used as a terminator.
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["/api/{version}"]
|
[["/api/{version}" {...}]
|
||||||
["/files/{name}.{extension}"]
|
["/files/{name}.{extension}" {...}]
|
||||||
["/user/{user-id}/orders"]]
|
["/user/{user-id}/orders" {...}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
Having multiple terminators after a bracket path-path parameter with identical path prefix will cause a compile-time error at router creation:
|
Having multiple terminators after a bracket path-path parameter with identical path prefix will cause a compile-time error at router creation:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["/files/file-{name}.pdf"] ;; terminator \.
|
[["/files/file-{name}.pdf" {...}] ;; terminator \.
|
||||||
["/files/file-{name}-{version}.pdf"]] ;; terminator \-
|
["/files/file-{name}-{version}.pdf" {...}]] ;; terminator \-
|
||||||
```
|
```
|
||||||
|
|
||||||
### Slash Free Routing
|
### Slash Free Routing
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[["broker.{customer}.{device}.{*data}"]
|
[["broker.{customer}.{device}.{*data}" {...}]
|
||||||
["events.{target}.{type}"]]
|
["events.{target}.{type}" {...}]]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Generating routes
|
### Generating routes
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,8 @@
|
||||||
metosin/reitit-swagger-ui
|
metosin/reitit-swagger-ui
|
||||||
metosin/reitit-frontend
|
metosin/reitit-frontend
|
||||||
metosin/reitit-sieppari
|
metosin/reitit-sieppari
|
||||||
metosin/reitit-pedestal]
|
metosin/reitit-pedestal
|
||||||
|
fi.metosin/reitit-openapi]
|
||||||
:cljdoc.doc/tree
|
:cljdoc.doc/tree
|
||||||
[["Introduction" {:file "doc/README.md"}]
|
[["Introduction" {:file "doc/README.md"}]
|
||||||
["Basics" {}
|
["Basics" {}
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ The [clojure.spec](https://clojure.org/guides/spec) library specifies the struct
|
||||||
|
|
||||||
For simple specs (core predicates, `spec-tools.core/spec`, `s/and`, `s/or`, `s/coll-of`, `s/keys`, `s/map-of`, `s/nillable` and `s/every`), the transformation is inferred using [spec-walker](https://github.com/metosin/spec-tools#spec-walker) and is automatic. To support all specs (like regex-specs), specs need to be wrapped into [Spec Records](https://github.com/metosin/spec-tools/blob/master/README.md#spec-records).
|
For simple specs (core predicates, `spec-tools.core/spec`, `s/and`, `s/or`, `s/coll-of`, `s/keys`, `s/map-of`, `s/nillable` and `s/every`), the transformation is inferred using [spec-walker](https://github.com/metosin/spec-tools#spec-walker) and is automatic. To support all specs (like regex-specs), specs need to be wrapped into [Spec Records](https://github.com/metosin/spec-tools/blob/master/README.md#spec-records).
|
||||||
|
|
||||||
There are [CLJ-2116](https://dev.clojure.org/jira/browse/CLJ-2116) and [CLJ-2251](https://dev.clojure.org/jira/browse/CLJ-2251) that would help solve this elegantly. Go vote 'em up.
|
There are [CLJ-2116](https://clojure.atlassian.net/browse/CLJ-2116) and [CLJ-2251](https://clojure.atlassian.net/browse/CLJ-2251) that would help solve this elegantly. Go vote 'em up.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Data-spec Coercion
|
# Data-spec Coercion
|
||||||
|
|
||||||
[Data-specs](https://github.com/metosin/spec-tools#data-specs) is alternative, macro-free syntax to define `clojure.spec`s. As a bonus, supports the [runtime transformations via conforming](https://dev.clojure.org/jira/browse/CLJ-2116) out-of-the-box.
|
[Data-specs](https://github.com/metosin/spec-tools#data-specs) is alternative, macro-free syntax to define `clojure.spec`s. As a bonus, supports the [runtime transformations via conforming](https://clojure.atlassian.net/browse/CLJ-2116) out-of-the-box.
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
(require '[reitit.coercion.spec])
|
(require '[reitit.coercion.spec])
|
||||||
|
|
|
||||||
|
|
@ -73,9 +73,10 @@ Using `create` with options to create the coercion instead of `coercion`:
|
||||||
{:transformers {:body {:default reitit.coercion.malli/default-transformer-provider
|
{:transformers {:body {:default reitit.coercion.malli/default-transformer-provider
|
||||||
:formats {"application/json" reitit.coercion.malli/json-transformer-provider}}
|
:formats {"application/json" reitit.coercion.malli/json-transformer-provider}}
|
||||||
:string {:default reitit.coercion.malli/string-transformer-provider}
|
:string {:default reitit.coercion.malli/string-transformer-provider}
|
||||||
:response {:default reitit.coercion.malli/default-transformer-provider}}
|
:response {:default reitit.coercion.malli/default-transformer-provider
|
||||||
|
:formats {"application/json" reitit.coercion.malli/json-transformer-provider}}}
|
||||||
;; set of keys to include in error messages
|
;; set of keys to include in error messages
|
||||||
:error-keys #{:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
:error-keys #{:type :coercion :in #_:schema :value #_:errors :humanized #_:transformed}
|
||||||
;; support lite syntax?
|
;; support lite syntax?
|
||||||
:lite true
|
:lite true
|
||||||
;; schema identity function (default: close all map schemas)
|
;; schema identity function (default: close all map schemas)
|
||||||
|
|
@ -84,10 +85,40 @@ Using `create` with options to create the coercion instead of `coercion`:
|
||||||
:validate true
|
:validate true
|
||||||
;; top-level short-circuit to disable request & response coercion
|
;; top-level short-circuit to disable request & response coercion
|
||||||
:enabled true
|
:enabled true
|
||||||
;; strip-extra-keys (effects only predefined transformers)
|
;; strip-extra-keys (affects only predefined transformers)
|
||||||
:strip-extra-keys true
|
:strip-extra-keys true
|
||||||
;; add/set default values
|
;; add/set default values
|
||||||
|
;; Can be false, true or a map of options to pass to malli.transform/default-value-transformer,
|
||||||
|
;; for example {:malli.transform/add-optional-keys true}
|
||||||
:default-values true
|
:default-values true
|
||||||
|
;; encode-error
|
||||||
|
:encode-error nil
|
||||||
;; malli options
|
;; malli options
|
||||||
:options nil})
|
:options nil})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Configuring humanize error messages
|
||||||
|
|
||||||
|
Malli humanized error messages can be configured using `:options :errors`:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(reitit.coercion.malli/create
|
||||||
|
{:options
|
||||||
|
{:errors (assoc malli.error/default-errors
|
||||||
|
:malli.core/missing-key {:error/message {:en "MISSING"}})}})
|
||||||
|
```
|
||||||
|
|
||||||
|
See the malli docs for more info.
|
||||||
|
|
||||||
|
## Custom registry
|
||||||
|
|
||||||
|
Malli registry can be configured conveniently via `:options :registry`:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(require '[malli.core :as m])
|
||||||
|
|
||||||
|
(reitit.coercion.malli/create
|
||||||
|
{:options
|
||||||
|
{:registry {:registry (merge (m/default-schemas)
|
||||||
|
{:my-type :string})}}})
|
||||||
|
```
|
||||||
|
|
|
||||||
|
|
@ -25,6 +25,14 @@ clojure-lsp clean-ns
|
||||||
The documentation lives under `doc` and it is hosted on [cljdoc](https://cljdoc.org). See their
|
The documentation lives under `doc` and it is hosted on [cljdoc](https://cljdoc.org). See their
|
||||||
documentation for [library authors](https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc)
|
documentation for [library authors](https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc)
|
||||||
|
|
||||||
|
## Updating deps
|
||||||
|
|
||||||
|
|
||||||
|
* `lein ancient upgrade`
|
||||||
|
* Mention non-dev non-test dep upgrades in CHANGELOG.md
|
||||||
|
* `npm update --save`
|
||||||
|
* Make a PR, run CI
|
||||||
|
|
||||||
## Making a release
|
## Making a release
|
||||||
|
|
||||||
We use [Break Versioning][breakver]. Remember our promise: patch-level bumps never include breaking changes!
|
We use [Break Versioning][breakver]. Remember our promise: patch-level bumps never include breaking changes!
|
||||||
|
|
@ -32,29 +40,20 @@ We use [Break Versioning][breakver]. Remember our promise: patch-level bumps nev
|
||||||
[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
|
[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check that you're using Java 8! Making the release with a newer Java version
|
# create a release commit
|
||||||
# means that it is broken when used with Java 8.
|
|
||||||
java -version
|
|
||||||
|
|
||||||
# new version
|
|
||||||
./scripts/set-version "1.0.0"
|
./scripts/set-version "1.0.0"
|
||||||
|
|
||||||
# create a release commit and a tag
|
# !!! update the changelog
|
||||||
git add -u
|
|
||||||
|
git add -u
|
||||||
git commit -m "Release 1.0.0"
|
git commit -m "Release 1.0.0"
|
||||||
git tag 1.0.0
|
|
||||||
|
|
||||||
# works
|
# push the commit
|
||||||
./scripts/lein-modules install
|
|
||||||
lein test
|
|
||||||
|
|
||||||
# deploy to clojars
|
|
||||||
CLOJARS_USERNAME=*** CLOJARS_PASSWORD=*** ./scripts/lein-modules do clean, deploy clojars
|
|
||||||
|
|
||||||
# push the commit and the tag
|
|
||||||
git push
|
git push
|
||||||
git push --tags
|
|
||||||
|
# !!! check that tests pass on CI
|
||||||
```
|
```
|
||||||
|
|
||||||
* Remembor to update the changelog!
|
* Create a new release on github at <https://github.com/metosin/reitit/releases>
|
||||||
|
* This will trigger the automated release workflow <https://github.com/metosin/reitit/actions/workflows/release.yml>
|
||||||
* Announce the release at least on #reitit in Clojurians.
|
* Announce the release at least on #reitit in Clojurians.
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,10 @@ history events
|
||||||
- Stateful wrapper for easy use of history integration
|
- Stateful wrapper for easy use of history integration
|
||||||
- Optional [controller extension](./controllers.md)
|
- Optional [controller extension](./controllers.md)
|
||||||
|
|
||||||
|
You likely won't use `reitit.frontend` directly in your apps and instead you
|
||||||
|
will use the API documented in the browser integration docs, which wraps these
|
||||||
|
lower level functions.
|
||||||
|
|
||||||
## Core functions
|
## Core functions
|
||||||
|
|
||||||
`reitit.frontend` provides some useful functions wrapping core functions:
|
`reitit.frontend` provides some useful functions wrapping core functions:
|
||||||
|
|
@ -23,7 +27,8 @@ enabled.
|
||||||
|
|
||||||
`match-by-name` and `match-by-name!` with optional `path-paramers` and
|
`match-by-name` and `match-by-name!` with optional `path-paramers` and
|
||||||
logging errors to `console.warn` instead of throwing errors to prevent
|
logging errors to `console.warn` instead of throwing errors to prevent
|
||||||
React breaking due to errors.
|
React breaking due to errors. These can also [encode query-parameters](./coercion.md)
|
||||||
|
using schema from match data.
|
||||||
|
|
||||||
## Next
|
## Next
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -13,6 +13,9 @@ There are also secondary functions following HTML5 History API:
|
||||||
`push-state` to navigate to new route adding entry to the history and
|
`push-state` to navigate to new route adding entry to the history and
|
||||||
`replace-state` to change route without leaving previous entry in browser history.
|
`replace-state` to change route without leaving previous entry in browser history.
|
||||||
|
|
||||||
|
See [coercion notes](./coercion.md) to see how frontend route parameters
|
||||||
|
can be decoded and encoded.
|
||||||
|
|
||||||
## Fragment router
|
## Fragment router
|
||||||
|
|
||||||
Fragment is simple integration which stores the current route in URL fragment,
|
Fragment is simple integration which stores the current route in URL fragment,
|
||||||
|
|
@ -62,7 +65,7 @@ event handler for page change events.
|
||||||
|
|
||||||
## History manipulation
|
## History manipulation
|
||||||
|
|
||||||
Reitit doesn't include functions to manipulate the history stack, i.e.
|
Reitit doesn't include functions to manipulate the history stack, i.e.,
|
||||||
go back or forwards, but calling History API functions directly should work:
|
go back or forwards, but calling History API functions directly should work:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
||||||
59
doc/frontend/coercion.md
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
# Frontend coercion
|
||||||
|
|
||||||
|
The Reitit frontend leverages [coercion](../coercion/coercion.md) for path,
|
||||||
|
query, and fragment parameters. The coercion uses the input schema defined
|
||||||
|
in the match data under `:parameters`.
|
||||||
|
|
||||||
|
## Behavior of Coercion
|
||||||
|
|
||||||
|
1. **Route Matching**
|
||||||
|
When matching a route from a path, the resulting match will include the
|
||||||
|
coerced values (if coercion is enabled) under `:parameters`. If coercion is
|
||||||
|
disabled, the parsed string values are stored in the same location.
|
||||||
|
The original un-coerced values are always available under `:path-params`,
|
||||||
|
`:query-params`, and `:fragment` (a single string).
|
||||||
|
|
||||||
|
2. **Creating Links and Navigating**
|
||||||
|
When generating a URL (`href`) or navigating (`push-state`, `replace-state`, `navigate`)
|
||||||
|
to a route, coercion can be
|
||||||
|
used to encode query-parameter values into strings. This happens before
|
||||||
|
Reitit performs basic URL encoding on the values. This feature is
|
||||||
|
especially useful for handling the encoding of specific types, such as
|
||||||
|
keywords or dates, into strings.
|
||||||
|
|
||||||
|
3. **Updating current query parameters**
|
||||||
|
When using `set-query` to modify current query parameters, Reitit frontend
|
||||||
|
first tries to find a match for the current path so the match can be used to
|
||||||
|
first decode query parameters and then to encode them. If the current path
|
||||||
|
doesn't match the routing tree, `set-query` keeps all the query parameter
|
||||||
|
values as strings.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- **Value Encoding Support**: Only Malli supports value encoding.
|
||||||
|
- **Limitations**: Path parameters and fragment values are not encoded using
|
||||||
|
the match schema.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```cljs
|
||||||
|
(def router (r/router ["/"
|
||||||
|
["" ::frontpage]
|
||||||
|
["bar"
|
||||||
|
{:name ::bar
|
||||||
|
:coercion rcm/coercion
|
||||||
|
:parameters {:query [:map
|
||||||
|
[:q {:optional true}
|
||||||
|
[:keyword
|
||||||
|
{:decode/string (fn [s] (keyword (subs s 2)))
|
||||||
|
:encode/string (fn [k] (str "__" (name k)))}]]]}}]]))
|
||||||
|
|
||||||
|
(rfe/href ::bar {} {:q :hello})
|
||||||
|
;; Result "/bar?q=__hello", the :q value is first encoded
|
||||||
|
|
||||||
|
(rfe/push-state ::bar {} {:q :world})
|
||||||
|
;; Result "/bar?q=__world"
|
||||||
|
;; The current match will contain both the original value and parsed & decoded parameters:
|
||||||
|
;; {:query-params {:q "__world"}
|
||||||
|
;; :parameters {:query {:q :world}}}
|
||||||
|
```
|
||||||
|
|
@ -1,13 +1,13 @@
|
||||||
# Default Interceptors
|
# Default Interceptors
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-interceptors "0.7.0-alpha1"]
|
[metosin/reitit-interceptors "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Just like the [ring default middleware](../ring/default_middleware.md), but for interceptors.
|
Just like the [ring default middleware](../ring/default_middleware.md), but for interceptors.
|
||||||
|
|
||||||
### Parameters handling
|
### Parameters handling
|
||||||
* `reitit.http.interceptors.parameters/parameters-interceptor`
|
* `reitit.http.interceptors.parameters/parameters-interceptor`
|
||||||
|
|
||||||
### Exception handling
|
### Exception handling
|
||||||
* `reitit.http.interceptors.exception/exception-interceptor`
|
* `reitit.http.interceptors.exception/exception-interceptor`
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ Reitit has also support for [interceptors](http://pedestal.io/reference/intercep
|
||||||
## Reitit-http
|
## Reitit-http
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-http "0.7.0-alpha1"]
|
[metosin/reitit-http "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
A module for http-routing using interceptors instead of middleware. Builds on top of the [`reitit-ring`](../ring/ring.md) module having all the same features.
|
A module for http-routing using interceptors instead of middleware. Builds on top of the [`reitit-ring`](../ring/ring.md) module having all the same features.
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
[Pedestal](http://pedestal.io/) is a backend web framework for Clojure. `reitit-pedestal` provides an alternative routing engine for Pedestal.
|
[Pedestal](http://pedestal.io/) is a backend web framework for Clojure. `reitit-pedestal` provides an alternative routing engine for Pedestal.
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-pedestal "0.7.0-alpha1"]
|
[metosin/reitit-pedestal "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Why should one use reitit instead of the Pedestal [default routing](http://pedestal.io/reference/routing-quick-reference)?
|
Why should one use reitit instead of the Pedestal [default routing](http://pedestal.io/reference/routing-quick-reference)?
|
||||||
|
|
@ -26,8 +26,8 @@ A minimalistic example on how to to swap the default-router with a reitit router
|
||||||
```clj
|
```clj
|
||||||
; [io.pedestal/pedestal.service "0.5.5"]
|
; [io.pedestal/pedestal.service "0.5.5"]
|
||||||
; [io.pedestal/pedestal.jetty "0.5.5"]
|
; [io.pedestal/pedestal.jetty "0.5.5"]
|
||||||
; [metosin/reitit-pedestal "0.7.0-alpha1"]
|
; [metosin/reitit-pedestal "0.10.0"]
|
||||||
; [metosin/reitit "0.7.0-alpha1"]
|
; [metosin/reitit "0.10.0"]
|
||||||
|
|
||||||
(require '[io.pedestal.http :as server])
|
(require '[io.pedestal.http :as server])
|
||||||
(require '[reitit.pedestal :as pedestal])
|
(require '[reitit.pedestal :as pedestal])
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Sieppari
|
# Sieppari
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-sieppari "0.7.0-alpha1"]
|
[metosin/reitit-sieppari "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
[Sieppari](https://github.com/metosin/sieppari) is a new and fast interceptor implementation for Clojure, with pluggable async supporting [core.async](https://github.com/clojure/core.async), [Manifold](https://github.com/ztellman/manifold) and [Promesa](http://funcool.github.io/promesa/latest).
|
[Sieppari](https://github.com/metosin/sieppari) is a new and fast interceptor implementation for Clojure, with pluggable async supporting [core.async](https://github.com/clojure/core.async), [Manifold](https://github.com/ztellman/manifold) and [Promesa](http://funcool.github.io/promesa/latest).
|
||||||
|
|
|
||||||
|
|
@ -65,7 +65,7 @@ There is an extra option in http-router (actually, in the underlying interceptor
|
||||||
### Printing Context Diffs
|
### Printing Context Diffs
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-interceptors "0.7.0-alpha1"]
|
[metosin/reitit-interceptors "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Using `reitit.http.interceptors.dev/print-context-diffs` transformation, the context diffs between each interceptor are printed out to the console. To use it, add the following router option:
|
Using `reitit.http.interceptors.dev/print-context-diffs` transformation, the context diffs between each interceptor are printed out to the console. To use it, add the following router option:
|
||||||
|
|
|
||||||
BIN
doc/images/reitit.png
Normal file
|
After Width: | Height: | Size: 127 KiB |
|
|
@ -37,7 +37,7 @@ Coercion can be attached to route data under `:coercion` key. There can be multi
|
||||||
|
|
||||||
Parameters are defined in route data under `:parameters` key. It's value should be a map of parameter `:type` -> Coercion Schema.
|
Parameters are defined in route data under `:parameters` key. It's value should be a map of parameter `:type` -> Coercion Schema.
|
||||||
|
|
||||||
Responses are defined in route data under `:responses` key. It's value should be a map of http status code to a map which can contain `:body` key with Coercion Schema as value.
|
Responses are defined in route data under `:responses` key. It's value should be a map of http status code to a map which can contain `:body` key with Coercion Schema as value. Additionally, the key `:default` specifies the coercion for other status codes.
|
||||||
|
|
||||||
Below is an example with [Plumatic Schema](https://github.com/plumatic/schema). It defines schemas for `:query`, `:body` and `:path` parameters and for http 200 response `:body`.
|
Below is an example with [Plumatic Schema](https://github.com/plumatic/schema). It defines schemas for `:query`, `:body` and `:path` parameters and for http 200 response `:body`.
|
||||||
|
|
||||||
|
|
@ -54,7 +54,8 @@ Handlers can access the coerced parameters via the `:parameters` key in the requ
|
||||||
:parameters {:query {:x s/Int}
|
:parameters {:query {:x s/Int}
|
||||||
:body {:y s/Int}
|
:body {:y s/Int}
|
||||||
:path {:z s/Int}}
|
:path {:z s/Int}}
|
||||||
:responses {200 {:body {:total PositiveInt}}}
|
:responses {200 {:body {:total PositiveInt}}
|
||||||
|
:default {:body {:error s/Str}}}
|
||||||
:handler (fn [{:keys [parameters]}]
|
:handler (fn [{:keys [parameters]}]
|
||||||
(let [total (+ (-> parameters :query :x)
|
(let [total (+ (-> parameters :query :x)
|
||||||
(-> parameters :body :y)
|
(-> parameters :body :y)
|
||||||
|
|
@ -62,6 +63,54 @@ Handlers can access the coerced parameters via the `:parameters` key in the requ
|
||||||
{:status 200
|
{:status 200
|
||||||
:body {:total total}}))})
|
:body {:total total}}))})
|
||||||
```
|
```
|
||||||
|
### Nested parameter definitions
|
||||||
|
|
||||||
|
Parameters are accumulated recursively along the route tree, just like
|
||||||
|
other [route data](../basics/route_data.md). There is special case
|
||||||
|
handling for merging eg. malli `:map` schemas.
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(def router
|
||||||
|
(reitit.ring/router
|
||||||
|
["/api" {:get {:parameters {:query [:map [:api-key :string]]}}}
|
||||||
|
["/project/:project-id" {:get {:parameters {:path [:map [:project-id :int]]}}}
|
||||||
|
["/task/:task-id" {:get {:parameters {:path [:map [:task-id :int]]
|
||||||
|
:query [:map [:details :boolean]]}
|
||||||
|
:handler (fn [req] (prn req))}}]]]
|
||||||
|
{:data {:coercion reitit.coercion.malli/coercion}}))
|
||||||
|
```
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(-> (r/match-by-path router "/api/project/1/task/2") :result :get :data :parameters)
|
||||||
|
; {:query [:map
|
||||||
|
; {:closed true}
|
||||||
|
; [:api-key :string]
|
||||||
|
; [:details :boolean]],
|
||||||
|
; :path [:map
|
||||||
|
; {:closed true}
|
||||||
|
; [:project-id :int]
|
||||||
|
; [:task-id :int]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Differences in behaviour for different parameters
|
||||||
|
|
||||||
|
All parameter coercions *except* `:body`:
|
||||||
|
|
||||||
|
1. Allow keys outside the schema (by opening up the schema using eg. `malli.util/open-schema`)
|
||||||
|
2. Keywordize the keys (ie. header & query parameter names) of the input before coercing
|
||||||
|
|
||||||
|
In contrast, the `:body` coercion:
|
||||||
|
|
||||||
|
1. Uses the specified schema
|
||||||
|
* depending on the coercion, it can be configured as open or closed, see specific coercion docs for details
|
||||||
|
2. Does not keywordize the keys of the input before coercion
|
||||||
|
* however, coercions like malli might do the keywordization when coercing json bodies, depending on configuration
|
||||||
|
|
||||||
|
This admittedly confusing behaviour is retained currently due to
|
||||||
|
backwards compatibility reasons. It can be configured by passing
|
||||||
|
option `:reitit.coercion/parameter-coercion` to `reitit.ring/router`
|
||||||
|
or `reitit.coercion/compile-request-coercers`. See also:
|
||||||
|
`reitit.coercion/default-parameter-coercion`.
|
||||||
|
|
||||||
## Coercion Middleware
|
## Coercion Middleware
|
||||||
|
|
||||||
|
|
@ -152,28 +201,51 @@ Invalid response:
|
||||||
|
|
||||||
## Per-content-type coercion
|
## Per-content-type coercion
|
||||||
|
|
||||||
You can also specify request and response body schemas per content-type. The syntax for this is:
|
You can also specify request and response body schemas per
|
||||||
|
content-type. These are also read by the [OpenAPI
|
||||||
|
feature](./openapi.md) when generating api docs. The syntax for this
|
||||||
|
is:
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
(def app
|
(def app
|
||||||
(ring/ring-handler
|
(ring/ring-handler
|
||||||
(ring/router
|
(ring/router
|
||||||
["/api"
|
["/api"
|
||||||
["/example" {:post {:coercion reitit.coercion.schema/coercion
|
["/example" {:post {:coercion reitit.coercion.schema/coercion
|
||||||
:parameters {:request {:content {"application/json" {:y s/Int}
|
:request {:content {"application/json" {:schema {:y s/Int}}
|
||||||
"application/edn" {:z s/Int}}
|
"application/edn" {:schema {:z s/Int}}
|
||||||
;; default if no content-type matches:
|
;; default if no content-type matches:
|
||||||
:body {:yy s/Int}}}
|
:default {:schema {:yy s/Int}}}}
|
||||||
:responses {200 {:content {"application/json" {:w s/Int}
|
:responses {200 {:content {"application/json" {:schema {:w s/Int}}
|
||||||
"application/edn" {:x s/Int}}
|
"application/edn" {:schema {:x s/Int}}
|
||||||
;; default if no content-type matches:
|
:default {:schema {:ww s/Int}}}}}
|
||||||
:body {:ww s/Int}}
|
:handler ...}}]]
|
||||||
:handler ...}}]]
|
{:data {:muuntaja muuntaja.core/instance
|
||||||
{:data {:middleware [rrc/coerce-exceptions-middleware
|
:middleware [reitit.ring.middleware.muuntaja/format-middleware
|
||||||
rrc/coerce-request-middleware
|
reitit.ring.coercion/coerce-exceptions-middleware
|
||||||
rrc/coerce-response-middleware]}})))
|
reitit.ring.coercion/coerce-request-middleware
|
||||||
|
reitit.ring.coercion/coerce-response-middleware]}})))
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The resolution logic for response coercers is:
|
||||||
|
1. Get the response status, or `:default` from the `:responses` map
|
||||||
|
2. From this map, get use the first of these to coerce:
|
||||||
|
1. `:content <content-type> :schema`
|
||||||
|
2. `:content :default :schema`
|
||||||
|
3. `:body`
|
||||||
|
3. If nothing was found, do not coerce
|
||||||
|
|
||||||
|
To select the response content-type, you can either:
|
||||||
|
1. Let muuntaja pick the content-type based on things like the request Accept header
|
||||||
|
- This is what most users want
|
||||||
|
2. Set `:muuntaja/content-type` in the response to pick an explicit content type
|
||||||
|
3. Set the `"Content-Type"` header in the response
|
||||||
|
- This disables muuntaja, so you need to encode your response body in some other way!
|
||||||
|
- This is not compatible with response schema checking, since coercion won't know what to do with the already-encoded response body.
|
||||||
|
4. Use the `:extract-response-format` option to inject your own logic. See `reitit.coercion/extract-response-format-default` for the default.
|
||||||
|
|
||||||
|
See also the [muuntaja content negotiation](./content_negotiation.md) docs.
|
||||||
|
|
||||||
## Pretty printing spec errors
|
## Pretty printing spec errors
|
||||||
|
|
||||||
Spec problems are exposed as is in request & response coercion errors. Pretty-printers like [expound](https://github.com/bhb/expound) can be enabled like this:
|
Spec problems are exposed as is in request & response coercion errors. Pretty-printers like [expound](https://github.com/bhb/expound) can be enabled like this:
|
||||||
|
|
|
||||||
|
|
@ -27,8 +27,8 @@ To demonstrate the two approaches, below is the response coercion middleware wri
|
||||||
coercion (-> match :data :coercion)
|
coercion (-> match :data :coercion)
|
||||||
opts (-> match :data :opts)]
|
opts (-> match :data :opts)]
|
||||||
(if (and coercion responses)
|
(if (and coercion responses)
|
||||||
(let [coercers (response-coercers coercion responses opts)]
|
(let [coercer (response-coercer coercion responses opts)]
|
||||||
(coerce-response coercers request response))
|
(coercer request response))
|
||||||
response)))
|
response)))
|
||||||
([request respond raise]
|
([request respond raise]
|
||||||
(let [method (:request-method request)
|
(let [method (:request-method request)
|
||||||
|
|
@ -37,8 +37,8 @@ To demonstrate the two approaches, below is the response coercion middleware wri
|
||||||
coercion (-> match :data :coercion)
|
coercion (-> match :data :coercion)
|
||||||
opts (-> match :data :opts)]
|
opts (-> match :data :opts)]
|
||||||
(if (and coercion responses)
|
(if (and coercion responses)
|
||||||
(let [coercers (response-coercers coercion responses opts)]
|
(let [coercer (response-coercer coercion responses opts)]
|
||||||
(handler request #(respond (coerce-response coercers request %))))
|
(handler request #(respond (coercer request %))))
|
||||||
(handler request respond raise))))))
|
(handler request respond raise))))))
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -60,13 +60,13 @@ To demonstrate the two approaches, below is the response coercion middleware wri
|
||||||
:spec ::rs/responses
|
:spec ::rs/responses
|
||||||
:compile (fn [{:keys [coercion responses]} opts]
|
:compile (fn [{:keys [coercion responses]} opts]
|
||||||
(if (and coercion responses)
|
(if (and coercion responses)
|
||||||
(let [coercers (coercion/response-coercers coercion responses opts)]
|
(let [coercer (coercion/response-coercer coercion responses opts)]
|
||||||
(fn [handler]
|
(fn [handler]
|
||||||
(fn
|
(fn
|
||||||
([request]
|
([request]
|
||||||
(coercion/coerce-response coercers request (handler request)))
|
(coercer request (handler request)))
|
||||||
([request respond raise]
|
([request respond raise]
|
||||||
(handler request #(respond (coercion/coerce-response coercers request %)) raise)))))))})
|
(handler request #(respond (coercer request %)) raise)))))))})
|
||||||
```
|
```
|
||||||
|
|
||||||
It has 50% less code, it's much easier to reason about and is much faster.
|
It has 50% less code, it's much easier to reason about and is much faster.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
Ring [defines middleware](https://github.com/ring-clojure/ring/wiki/Concepts#middleware) as a function of type `handler & args => request => response`. It is relatively easy to understand and allows for good performance. A downside is that the middleware chain is just a opaque function, making things like debugging and composition hard. It is too easy to apply the middlewares in wrong order.
|
Ring [defines middleware](https://github.com/ring-clojure/ring/wiki/Concepts#middleware) as a function of type `handler & args => request => response`. It is relatively easy to understand and allows for good performance. A downside is that the middleware chain is just a opaque function, making things like debugging and composition hard. It is too easy to apply the middlewares in wrong order.
|
||||||
|
|
||||||
|
For the basics of reitit middleware, [read this first](ring.md#middleware).
|
||||||
|
|
||||||
Reitit defines middleware as data:
|
Reitit defines middleware as data:
|
||||||
|
|
||||||
1. A middleware can be defined as first-class data entries
|
1. A middleware can be defined as first-class data entries
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Default Middleware
|
# Default Middleware
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-middleware "0.7.0-alpha1"]
|
[metosin/reitit-middleware "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Any Ring middleware can be used with `reitit-ring`, but using data-driven middleware is preferred as they are easier to manage and in many cases yield better performance. `reitit-middleware` contains a set of common ring middleware, lifted into data-driven middleware.
|
Any Ring middleware can be used with `reitit-ring`, but using data-driven middleware is preferred as they are easier to manage and in many cases yield better performance. `reitit-middleware` contains a set of common ring middleware, lifted into data-driven middleware.
|
||||||
|
|
@ -17,8 +17,6 @@ Any Ring middleware can be used with `reitit-ring`, but using data-driven middle
|
||||||
`reitit.ring.middleware.parameters/parameters-middleware` to capture query- and form-params. Wraps
|
`reitit.ring.middleware.parameters/parameters-middleware` to capture query- and form-params. Wraps
|
||||||
`ring.middleware.params/wrap-params`.
|
`ring.middleware.params/wrap-params`.
|
||||||
|
|
||||||
**NOTE**: This middleware will be factored into two parts: a query-parameters middleware and a Muuntaja format responsible for the the `application/x-www-form-urlencoded` body format. cf. https://github.com/metosin/reitit/issues/134
|
|
||||||
|
|
||||||
## Exception Handling
|
## Exception Handling
|
||||||
|
|
||||||
See [Exception Handling with Ring](exceptions.md).
|
See [Exception Handling with Ring](exceptions.md).
|
||||||
|
|
@ -59,4 +57,4 @@ Partial sample output:
|
||||||
|
|
||||||
## Example app
|
## Example app
|
||||||
|
|
||||||
See an example app with the default middleware in action: https://github.com/metosin/reitit/blob/master/examples/ring-swagger/src/example/server.clj.
|
See an example app with the default middleware in action: <https://github.com/metosin/reitit/blob/master/examples/ring-malli-swagger/src/example/server.clj>.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Exception Handling with Ring
|
# Exception Handling with Ring
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-middleware "0.7.0-alpha1"]
|
[metosin/reitit-middleware "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Exceptions thrown in router creation can be [handled with custom exception handler](../basics/error_messages.md). By default, exceptions thrown at runtime from a handler or a middleware are not caught by the `reitit.ring/ring-handler`. A good practice is to have a top-level exception handler to log and format errors for clients.
|
Exceptions thrown in router creation can be [handled with custom exception handler](../basics/error_messages.md). By default, exceptions thrown at runtime from a handler or a middleware are not caught by the `reitit.ring/ring-handler`. A good practice is to have a top-level exception handler to log and format errors for clients.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
The `:middleware` syntax in `reitit-ring` also supports Keywords. Keywords are looked up from the Middleware Registry, which is a map of `keyword => IntoMiddleware`. Middleware registry should be stored under key `:reitit.middleware/registry` in the router options. If a middleware keyword isn't found in the registry, router creation fails fast with a descriptive error message.
|
The `:middleware` syntax in `reitit-ring` also supports Keywords. Keywords are looked up from the Middleware Registry, which is a map of `keyword => IntoMiddleware`. Middleware registry should be stored under key `:reitit.middleware/registry` in the router options. If a middleware keyword isn't found in the registry, router creation fails fast with a descriptive error message.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Application using middleware defined in the Middleware Registry:
|
Application using middleware defined in the Middleware Registry:
|
||||||
|
|
||||||
|
|
@ -52,6 +52,20 @@ Router creation fails fast if the registry doesn't contain the middleware:
|
||||||
;| :bonus | reitit.ring_test$wrap_bonus@59fddabb |
|
;| :bonus | reitit.ring_test$wrap_bonus@59fddabb |
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Middleware defined in the registry can also be used on the `ring-handler` level:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(def app
|
||||||
|
(ring/ring-handler
|
||||||
|
(ring/router
|
||||||
|
["/api"
|
||||||
|
["/bonus" {:get (fn [{:keys [bonus]}]
|
||||||
|
{:status 200, :body {:bonus bonus}})}]]
|
||||||
|
{::middleware/registry {:bonus wrap-bonus}})
|
||||||
|
nil
|
||||||
|
{:middleware [[:bonus 15]]}))
|
||||||
|
```
|
||||||
|
|
||||||
## When to use the registry?
|
## When to use the registry?
|
||||||
|
|
||||||
Middleware as Keywords helps to keep the routes (all but handlers) as literal data (i.e. data that evaluates to itself), enabling the routes to be persisted in external formats like EDN-files and databases. Duct is a good example, where the [middleware can be referenced from EDN-files](https://github.com/duct-framework/duct/wiki/Configuration). It should be easy to make Duct configuration a Middleware Registry in `reitit-ring`.
|
Middleware as Keywords helps to keep the routes (all but handlers) as literal data (i.e. data that evaluates to itself), enabling the routes to be persisted in external formats like EDN-files and databases. Duct is a good example, where the [middleware can be referenced from EDN-files](https://github.com/duct-framework/duct/wiki/Configuration). It should be easy to make Duct configuration a Middleware Registry in `reitit-ring`.
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,12 @@
|
||||||
Reitit can generate [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0)
|
Reitit can generate [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0)
|
||||||
documentation. The feature works similarly to [Swagger documentation](swagger.md).
|
documentation. The feature works similarly to [Swagger documentation](swagger.md).
|
||||||
|
|
||||||
The [http-swagger](../../examples/http-swagger) and
|
The main example is [examples/openapi](../../examples/openapi).
|
||||||
[ring-malli-swagger](../../examples/ring-malli-swagger) examples also
|
The
|
||||||
|
[ring-malli-swagger](../../examples/ring-malli-swagger)
|
||||||
|
and
|
||||||
|
[ring-spec-swagger](../../examples/ring-spec-swagger)
|
||||||
|
examples also
|
||||||
have OpenAPI documentation.
|
have OpenAPI documentation.
|
||||||
|
|
||||||
## OpenAPI data
|
## OpenAPI data
|
||||||
|
|
@ -16,49 +20,64 @@ The following route data keys contribute to the generated swagger specification:
|
||||||
| key | description |
|
| key | description |
|
||||||
| ---------------|-------------|
|
| ---------------|-------------|
|
||||||
| :openapi | map of any openapi data. Can contain keys like `:deprecated`.
|
| :openapi | map of any openapi data. Can contain keys like `:deprecated`.
|
||||||
| :content-types | vector of supported content types. Defaults to `["application/json"]`
|
|
||||||
| :no-doc | optional boolean to exclude endpoint from api docs
|
| :no-doc | optional boolean to exclude endpoint from api docs
|
||||||
| :tags | optional set of string or keyword tags for an endpoint api docs
|
| :tags | optional set of string or keyword tags for an endpoint api docs
|
||||||
| :summary | optional short string summary of an endpoint
|
| :summary | optional short string summary of an endpoint
|
||||||
| :description | optional long description of an endpoint. Supports http://spec.commonmark.org/
|
| :description | optional long description of an endpoint. Supports http://spec.commonmark.org/
|
||||||
|
| :openapi/request-content-types | See the Per-content-type-coercions section below.
|
||||||
|
| :openapi/response-content-types |See the Per-content-type-coercions section below. vector of supported response content types. Defaults to `["application/json"]`. Only needed if you use the [:response nnn :content :default] coercion.
|
||||||
|
|
||||||
Coercion keys also contribute to the docs:
|
Coercion keys also contribute to the docs:
|
||||||
|
|
||||||
| key | description |
|
| key | description |
|
||||||
| --------------|-------------|
|
| --------------|-------------|
|
||||||
| :parameters | optional input parameters for a route, in a format defined by the coercion
|
| :parameters | optional input parameters for a route, in a format defined by the coercion
|
||||||
|
| :request | optional description of body parameters, possibly per content-type
|
||||||
| :responses | optional descriptions of responses, in a format defined by coercion
|
| :responses | optional descriptions of responses, in a format defined by coercion
|
||||||
|
|
||||||
Use `:request` parameter coercion (instead of `:body`) to unlock per-content-type coercions. See [Coercion](coercion.md).
|
|
||||||
|
|
||||||
## Custom OpenAPI data
|
## Per-content-type coercions
|
||||||
|
|
||||||
The `:openapi` route data key can be used to add top-level or
|
Use `:request` coercion (instead of `:body`) to unlock
|
||||||
route-level information to the generated OpenAPI spec. This is useful
|
per-content-type coercions. This also lets you specify multiple named
|
||||||
for providing `"securitySchemes"`, `"examples"` or other OpenAPI keys
|
examples. See [Coercion](coercion.md) for more info. See also [the
|
||||||
that are not generated automatically by reitit.
|
openapi example](../../examples/openapi).
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
["/foo"
|
["/pizza"
|
||||||
{:post {:parameters {:body {:name string? :age int?}}
|
{:get {:summary "Fetch a pizza | Multiple content-types, multiple examples"
|
||||||
:openapi {:requestBody
|
:responses {200 {:description "Fetch a pizza as json or EDN"
|
||||||
{:content
|
:content {"application/json" {:schema [:map
|
||||||
{"application/json"
|
[:color :keyword]
|
||||||
{:examples {"Pyry" {:summary "Pyry, 45y"
|
[:pineapple :boolean]]
|
||||||
:value {:name "Pyry" :age 45}}
|
:examples {:white {:description "White pizza with pineapple"
|
||||||
"Cat" {:summary "Cat, 8y"
|
:value {:color :white
|
||||||
:value {:name "Cat" :age 8}}}}}}}
|
:pineapple true}}
|
||||||
...}}]
|
:red {:description "Red pizza"
|
||||||
|
:value {:color :red
|
||||||
|
:pineapple false}}}}
|
||||||
|
"application/edn" {:schema [:map
|
||||||
|
[:color :keyword]
|
||||||
|
[:pineapple :boolean]]
|
||||||
|
:examples {:red {:description "Red pizza with pineapple"
|
||||||
|
:value (pr-str {:color :red :pineapple true})}}}}}}
|
||||||
```
|
```
|
||||||
|
|
||||||
See [the http-swagger example](../../examples/http-swagger) for a
|
The special `:default` content types map to the content types supported by the Muuntaja
|
||||||
working examples of `"securitySchemes"` and `"examples"`.
|
instance. You can override these by using the `:openapi/request-content-types`
|
||||||
|
and `:openapi/response-content-types` keys, which must contain vector of
|
||||||
|
supported content types. If there is no Muuntaja instance, and these keys are
|
||||||
|
not defined, the content types will default to `["application/json"]`.
|
||||||
|
|
||||||
## OpenAPI spec
|
## OpenAPI spec
|
||||||
|
|
||||||
Serving the OpenAPI specification is handled by `reitit.openapi/create-openapi-handler`. It takes no arguments and returns a ring handler which collects at request-time data from all routes and returns an OpenAPI specification as Clojure data, to be encoded by a response formatter.
|
Serving the OpenAPI specification is handled by
|
||||||
|
`reitit.openapi/create-openapi-handler`. It takes no arguments and returns a
|
||||||
|
ring handler which collects at request-time data from all routes and returns an
|
||||||
|
OpenAPI specification as Clojure data, to be encoded by a response formatter.
|
||||||
|
|
||||||
You can use the `:openapi` route data key of the `create-openapi-handler` route to populate the top level of the OpenAPI spec.
|
You can use the `:openapi` route data key of the `create-openapi-handler` route
|
||||||
|
to populate the top level of the OpenAPI spec.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|
@ -73,6 +92,123 @@ If you need to post-process the generated spec, just wrap the handler with a cus
|
||||||
|
|
||||||
## Swagger-ui
|
## Swagger-ui
|
||||||
|
|
||||||
[Swagger-UI](https://github.com/swagger-api/swagger-ui) is a user interface to visualize and interact with the Swagger specification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module.
|
[Swagger-UI](https://github.com/swagger-api/swagger-ui) is a user interface to visualize and interact with the Swagger specification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module. See `reitit.swagger-ui/create-swagger-ui-handle`
|
||||||
|
|
||||||
Note: you need Swagger-UI 5 for OpenAPI 3.1 support. As of 2023-03-10, a v5.0.0-alpha.0 is out.
|
## Finetuning the OpenAPI output
|
||||||
|
|
||||||
|
There are a number of ways you can specify extra data that gets
|
||||||
|
included in the OpenAPI spec.
|
||||||
|
|
||||||
|
### Custom OpenAPI data
|
||||||
|
|
||||||
|
The `:openapi` route data key can be used to add top-level or
|
||||||
|
route-level information to the generated OpenAPI spec.
|
||||||
|
|
||||||
|
A straightforward use case is adding `"externalDocs"`:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
["/account"
|
||||||
|
{:get {:summary "Fetch an account | Recursive schemas using malli registry, link to external docs"
|
||||||
|
:openapi {:externalDocs {:description "The reitit repository"
|
||||||
|
:url "https://github.com/metosin/reitit"}}
|
||||||
|
...}}]
|
||||||
|
```
|
||||||
|
|
||||||
|
In a more complex use case is providing `"securitySchemes"`. See
|
||||||
|
[the openapi example](../../examples/openapi) for a working example of
|
||||||
|
`"securitySchemes"`. See also the
|
||||||
|
[OpenAPI docs](https://spec.openapis.org/oas/v3.1.0.html#security-scheme-object)
|
||||||
|
|
||||||
|
### Annotating schemas
|
||||||
|
|
||||||
|
You can use malli properties, schema-tools data or spec-tools data to
|
||||||
|
annotate your models with examples, descriptions and defaults that
|
||||||
|
show up in the OpenAPI spec.
|
||||||
|
|
||||||
|
This approach lets you add additional keys to the
|
||||||
|
[OpenAPI Schema Objects](https://spec.openapis.org/oas/v3.1.0.html#schema-object).
|
||||||
|
The most common ones are default and example values for parameters.
|
||||||
|
|
||||||
|
Malli:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
["/plus"
|
||||||
|
{:post
|
||||||
|
{:parameters
|
||||||
|
{:body [:map
|
||||||
|
[:x
|
||||||
|
{:title "X parameter"
|
||||||
|
:description "Description for X parameter"
|
||||||
|
:json-schema/deprecated true
|
||||||
|
:json-schema/default 42}
|
||||||
|
int?]
|
||||||
|
[:y int?]]}}}]
|
||||||
|
```
|
||||||
|
|
||||||
|
Schema:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
["/plus"
|
||||||
|
{:post
|
||||||
|
{:parameters
|
||||||
|
{:body {:x (schema-tools.core/schema s/Num {:description "Description for X parameter"
|
||||||
|
:openapi/deprecated true
|
||||||
|
:openapi/example 13
|
||||||
|
:openapi/default 42})
|
||||||
|
:y int?}}}}]
|
||||||
|
```
|
||||||
|
|
||||||
|
Spec:
|
||||||
|
|
||||||
|
```clj
|
||||||
|
["/plus"
|
||||||
|
{:post
|
||||||
|
{:parameters
|
||||||
|
{:body (spec-tools.data-spec/spec ::foo
|
||||||
|
{:x (schema-tools.core/spec {:spec int?
|
||||||
|
:description "Description for X parameter"
|
||||||
|
:openapi/deprecated true
|
||||||
|
:openapi/example 13
|
||||||
|
:openapi/default 42})
|
||||||
|
:y int?}}}}}]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Adding examples
|
||||||
|
|
||||||
|
Adding request/response examples have been mentioned above a couple of times
|
||||||
|
above. Here's a summary of the different ways to do it:
|
||||||
|
|
||||||
|
1. Add an example to the schema object using a `:openapi/example`
|
||||||
|
(schema, spec) or `:json-schema/example` (malli) key in your
|
||||||
|
schema/spec/malli model metadata. See the examples above.
|
||||||
|
2. Use `:example` (a single example) or `:examples` (named examples)
|
||||||
|
with per-content-type coercion.
|
||||||
|
|
||||||
|
**Caveat!** When adding examples for query parameters (or headers),
|
||||||
|
you must add the examples to the individual parameters, not the map
|
||||||
|
schema surrounding them. This is due to limitations in how OpenAPI
|
||||||
|
represents query parameters.
|
||||||
|
|
||||||
|
```clj
|
||||||
|
;; Wrong!
|
||||||
|
{:parameters {:query [:map
|
||||||
|
{:json-schema/example {:a 1}}
|
||||||
|
[:a :int]]}}
|
||||||
|
;; Right!
|
||||||
|
{:parameters {:query [:map
|
||||||
|
[:a {:json-schema/example 1} :int]]}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Named schemas
|
||||||
|
|
||||||
|
OpenAPI supports reusable schema objects that can be referred to with
|
||||||
|
the `"$ref": "#/components/schemas/Foo"` json-schema syntax. This is
|
||||||
|
useful when you have multiple endpoints that use the same schema. It
|
||||||
|
can also make OpenAPI-based code nicer for consumers of your API.
|
||||||
|
These schemas are also rendered in their own section in Swagger UI.
|
||||||
|
|
||||||
|
Reusable schema objects are generated for Malli `:ref`s and vars. The
|
||||||
|
[openapi example](../../examples/openapi) showcases this.
|
||||||
|
|
||||||
|
Currently (as of 0.7.2), reusable schema objects are **not** generated
|
||||||
|
for Plumatic Schema or Spec.
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
Read more about the [Ring Concepts](https://github.com/ring-clojure/ring/wiki/Concepts).
|
Read more about the [Ring Concepts](https://github.com/ring-clojure/ring/wiki/Concepts).
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-ring "0.7.0-alpha1"]
|
[metosin/reitit-ring "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
## `reitit.ring/router`
|
## `reitit.ring/router`
|
||||||
|
|
@ -141,7 +141,7 @@ Name-based reverse routing:
|
||||||
|
|
||||||
# Middleware
|
# Middleware
|
||||||
|
|
||||||
Middleware can be mounted using a `:middleware` key - either to top-level or under request method submap. Its value should be a vector of `reitit.middleware/IntoMiddleware` values. These include:
|
Middleware can be mounted using a `:middleware` key in [Route Data](../basics/route_data.md) - either to top-level or under request method submap. Its value should be a vector of `reitit.middleware/IntoMiddleware` values. These include:
|
||||||
|
|
||||||
1. normal ring middleware function `handler -> request -> response`
|
1. normal ring middleware function `handler -> request -> response`
|
||||||
2. vector of middleware function `[handler args*] -> request -> response` and it's arguments
|
2. vector of middleware function `[handler args*] -> request -> response` and it's arguments
|
||||||
|
|
@ -194,11 +194,56 @@ Top-level middleware, applied before any routing is done:
|
||||||
(def app
|
(def app
|
||||||
(ring/ring-handler
|
(ring/ring-handler
|
||||||
(ring/router
|
(ring/router
|
||||||
["/api" {:middleware [[mw :api]]}
|
["/api" {:middleware [[wrap :api]]}
|
||||||
["/get" {:get handler}]])
|
["/get" {:get handler}]])
|
||||||
nil
|
nil
|
||||||
{:middleware [[mw :top]]}))
|
{:middleware [[wrap :top]]}))
|
||||||
|
|
||||||
(app {:request-method :get, :uri "/api/get"})
|
(app {:request-method :get, :uri "/api/get"})
|
||||||
; {:status 200, :body [:top :api :ok]}
|
; {:status 200, :body [:top :api :ok]}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Same middleware for all routes, using [top-level route data](route_data.md#top-level-route-data):
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(def app
|
||||||
|
(ring/ring-handler
|
||||||
|
(ring/router
|
||||||
|
["/api"
|
||||||
|
["/get" {:get handler
|
||||||
|
:middleware [[wrap :specific]]}]]
|
||||||
|
{:data {:middleware [[wrap :generic]]}})))
|
||||||
|
|
||||||
|
(app {:request-method :get, :uri "/api/get"})
|
||||||
|
; {:status 200, :body [:generic :specific :handler]}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Execution order
|
||||||
|
|
||||||
|
Here's a full example that shows the execution order of the middleware
|
||||||
|
using all of the above techniques:
|
||||||
|
|
||||||
|
|
||||||
|
```clj
|
||||||
|
(def app
|
||||||
|
(ring/ring-handler
|
||||||
|
(ring/router
|
||||||
|
["/api" {:middleware [[wrap :3-parent]]}
|
||||||
|
["/get" {:get handler
|
||||||
|
:middleware [[wrap :4-route]]}]]
|
||||||
|
{:data {:middleware [[wrap :2-top-level-route-data]]}})
|
||||||
|
nil
|
||||||
|
{:middleware [[wrap :1-top]]}))
|
||||||
|
|
||||||
|
(app {:request-method :get, :uri "/api/get"})
|
||||||
|
; {:status 200, :body [:1-top :2-top-level-route-data :3-parent :4-route :handler]}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Which method should I use for defining middleware?
|
||||||
|
|
||||||
|
- If you have middleware that you want to apply to the default handler (second argument of `ring/ring-handler`), use _top-level middleware_
|
||||||
|
- If you have a generic middleware, that doesn't depend on the route, use _top-level middleware_ or _top-level route data_
|
||||||
|
- If you are using top-level route data anyway for some other reasons, it might be clearest to have all the middleware there. This is what most of the reitit examples do.
|
||||||
|
- If you want to apply a middleware to only a couple of routes, use _nested middleware_ (ie. _route data_)
|
||||||
|
- If you want a middleware to apply to all routes, but use route-specific data, you need _top-level route data_ combined with [Compiling Middleware](compiling_middleware.md)
|
||||||
|
- This is what many reitit features like [Ring Coercion](coercion.md) do. Check the examples & docs for the reitit features you want to use!
|
||||||
|
|
|
||||||
|
|
@ -54,14 +54,16 @@ This way, they are only served if none of the actual routes have matched.
|
||||||
|
|
||||||
`reitit.ring/create-file-handler` and `reitit.ring/create-resource-handler` take optionally an options map to configure how the files are being served.
|
`reitit.ring/create-file-handler` and `reitit.ring/create-resource-handler` take optionally an options map to configure how the files are being served.
|
||||||
|
|
||||||
| key | description |
|
| key | description |
|
||||||
| -------------------|-------------|
|
| --------------------|-------------|
|
||||||
| :parameter | optional name of the wildcard parameter, defaults to unnamed keyword `:`
|
| :parameter | optional name of the wildcard parameter, defaults to unnamed keyword `:`
|
||||||
| :root | optional resource root, defaults to `\"public\"`
|
| :root | optional resource root, defaults to `\"public\"`
|
||||||
| :path | path to mount the handler to. Required when mounted outside of a router, does not work inside a router.
|
| :path | path to mount the handler to. Required when mounted outside of a router, does not work inside a router.
|
||||||
| :loader | optional class loader to resolve the resources
|
| :loader | optional class loader to resolve the resources
|
||||||
| :index-files | optional vector of index-files to look in a resource directory, defaults to `[\"index.html\"]`
|
| :index-files | optional vector of index-files to look in a resource directory, defaults to `[\"index.html\"]`
|
||||||
| :not-found-handler | optional handler function to use if the requested resource is missing (404 Not Found)
|
| :index-redirect? | optional boolean: if true (default false), redirect to index file, if false serve it directly
|
||||||
|
| :canonicalize-uris? | optional boolean: if true (default), try to serve index files for non directory paths (paths that end with slash)
|
||||||
|
| :not-found-handler | optional handler function to use if the requested resource is missing (404 Not Found)
|
||||||
|
|
||||||
|
|
||||||
### TODO
|
### TODO
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Swagger Support
|
# Swagger Support
|
||||||
|
|
||||||
```
|
```
|
||||||
[metosin/reitit-swagger "0.7.0-alpha1"]
|
[metosin/reitit-swagger "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Reitit supports [Swagger2](https://swagger.io/) documentation, thanks to [schema-tools](https://github.com/metosin/schema-tools) and [spec-tools](https://github.com/metosin/spec-tools). Documentation is extracted from route definitions, coercion `:parameters` and `:responses` and from a set of new documentation keys.
|
Reitit supports [Swagger2](https://swagger.io/) documentation, thanks to [schema-tools](https://github.com/metosin/schema-tools) and [spec-tools](https://github.com/metosin/spec-tools). Documentation is extracted from route definitions, coercion `:parameters` and `:responses` and from a set of new documentation keys.
|
||||||
|
|
@ -47,7 +47,7 @@ If you need to post-process the generated spec, just wrap the handler with a cus
|
||||||
[Swagger-ui](https://github.com/swagger-api/swagger-ui) is a user interface to visualize and interact with the Swagger specification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module.
|
[Swagger-ui](https://github.com/swagger-api/swagger-ui) is a user interface to visualize and interact with the Swagger specification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module.
|
||||||
|
|
||||||
```
|
```
|
||||||
[metosin/reitit-swagger-ui "0.7.0-alpha1"]
|
[metosin/reitit-swagger-ui "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
`reitit.swagger-ui/create-swagger-ui-handler` can be used to create a ring-handler to serve the swagger-ui. It accepts the following options:
|
`reitit.swagger-ui/create-swagger-ui-handler` can be used to create a ring-handler to serve the swagger-ui. It accepts the following options:
|
||||||
|
|
@ -145,7 +145,7 @@ Another way to serve the swagger-ui is using the [default handler](default_handl
|
||||||
* missed routes are handled by `create-default-handler`
|
* missed routes are handled by `create-default-handler`
|
||||||
* served via [ring-jetty](https://github.com/ring-clojure/ring/tree/master/ring-jetty-adapter)
|
* served via [ring-jetty](https://github.com/ring-clojure/ring/tree/master/ring-jetty-adapter)
|
||||||
|
|
||||||
Whole example project is in [`/examples/ring-swagger`](https://github.com/metosin/reitit/tree/master/examples/ring-swagger).
|
Whole example project is in [`/examples/ring-spec-swagger`](https://github.com/metosin/reitit/tree/master/examples/ring-spec-swagger).
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
(ns example.server
|
(ns example.server
|
||||||
|
|
@ -286,7 +286,18 @@ Example with:
|
||||||
; ("/common/ping" "/one/ping" "/two/ping" "/two/deep/ping")
|
; ("/common/ping" "/one/ping" "/two/ping" "/two/deep/ping")
|
||||||
```
|
```
|
||||||
|
|
||||||
### TODO
|
## Reusable schema definitions
|
||||||
|
|
||||||
|
Swagger supports having reusable schema definitions under the
|
||||||
|
`"definitions"` key. These can be reused in different parts of
|
||||||
|
swagger.json using the `"$ref": "#/definitions/Foo"` syntax. These
|
||||||
|
definitions are also rendered in their own section in Swagger UI.
|
||||||
|
|
||||||
|
Reusable schema objects are generated for Malli `:ref`s and vars.
|
||||||
|
Currently (as of 0.7.2), reusable schema objects are **not** generated
|
||||||
|
for Plumatic Schema or Spec.
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
|
||||||
* ClojureScript
|
* ClojureScript
|
||||||
* example for [Macchiato](https://github.com/macchiato-framework)
|
* example for [Macchiato](https://github.com/macchiato-framework)
|
||||||
|
|
|
||||||
|
|
@ -59,7 +59,7 @@ There is an extra option in the Ring router (actually, in the underlying middlew
|
||||||
### Printing Request Diffs
|
### Printing Request Diffs
|
||||||
|
|
||||||
```clj
|
```clj
|
||||||
[metosin/reitit-middleware "0.7.0-alpha1"]
|
[metosin/reitit-middleware "0.10.0"]
|
||||||
```
|
```
|
||||||
|
|
||||||
Using `reitit.ring.middleware.dev/print-request-diffs` transformation, the request diffs between each middleware are printed out to the console. To use it, add the following router option:
|
Using `reitit.ring.middleware.dev/print-request-diffs` transformation, the request diffs between each middleware are printed out to the console. To use it, add the following router option:
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,13 @@
|
||||||
## frontend-prompt
|
## frontend-prompt
|
||||||
## frontend-re-frame
|
## frontend-re-frame
|
||||||
## frontend
|
## frontend
|
||||||
|
|
||||||
|
Frontend example with clojure.spec coercion.
|
||||||
|
|
||||||
|
## frontend-malli
|
||||||
|
|
||||||
|
Frontend example with Malli coercion.
|
||||||
|
|
||||||
## http-swagger
|
## http-swagger
|
||||||
|
|
||||||
Coercion with Spec and Swagger generation.
|
Coercion with Spec and Swagger generation.
|
||||||
|
|
@ -44,7 +51,3 @@ Coercion with Malli and Swagger generation.
|
||||||
## ring-spec-swagger
|
## ring-spec-swagger
|
||||||
|
|
||||||
Coercion with Spec and Swagger generation.
|
Coercion with Spec and Swagger generation.
|
||||||
|
|
||||||
## ring-swagger
|
|
||||||
|
|
||||||
Coercion with Spec and Swagger generation. Same as previous!
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject buddy-auth "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Buddy Auth App"
|
:description "Reitit Buddy Auth App"
|
||||||
:dependencies [[org.clojure/clojure "1.10.1"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring/ring-jetty-adapter "1.8.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[buddy "2.0.0"]]
|
[buddy "2.0.0"]]
|
||||||
:repl-options {:init-ns example.server})
|
:repl-options {:init-ns example.server})
|
||||||
|
|
|
||||||
|
|
@ -1,23 +1,25 @@
|
||||||
(defproject frontend "0.1.0-SNAPSHOT"
|
(defproject frontend-auth "0.1.0-SNAPSHOT"
|
||||||
:description "FIXME: write description"
|
:description "FIXME: write description"
|
||||||
:url "http://example.com/FIXME"
|
:url "http://example.com/FIXME"
|
||||||
:license {:name "Eclipse Public License"
|
:license {:name "Eclipse Public License"
|
||||||
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||||
|
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring-server "0.5.0"]
|
[ring-server "0.5.0"]
|
||||||
[reagent "0.8.1"]
|
[reagent "1.2.0"]
|
||||||
[ring "1.7.1"]
|
[ring "1.12.1"]
|
||||||
[hiccup "1.0.5"]
|
[hiccup "1.0.5"]
|
||||||
[org.clojure/clojurescript "1.10.439"]
|
[org.clojure/clojurescript "1.11.132"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/reitit-schema "0.7.0-alpha1"]
|
[metosin/reitit-schema "0.10.0"]
|
||||||
[metosin/reitit-frontend "0.7.0-alpha1"]
|
[metosin/reitit-frontend "0.10.0"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]
|
||||||
;; Just for pretty printting the match
|
;; Just for pretty printting the match
|
||||||
[fipp "0.6.14"]]
|
[fipp "0.6.14"]]
|
||||||
|
|
||||||
:plugins [[lein-cljsbuild "1.1.7"]
|
:plugins [[lein-cljsbuild "1.1.8"]
|
||||||
[lein-figwheel "0.5.18"]]
|
[lein-figwheel "0.5.20"]]
|
||||||
|
|
||||||
:source-paths []
|
:source-paths []
|
||||||
:resource-paths ["resources" "target/cljsbuild"]
|
:resource-paths ["resources" "target/cljsbuild"]
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
(ns frontend.core
|
(ns frontend.core
|
||||||
(:require [reagent.core :as r]
|
(:require [reagent.core :as r]
|
||||||
|
[reagent.dom :as rd]
|
||||||
[reitit.frontend :as rf]
|
[reitit.frontend :as rf]
|
||||||
[reitit.frontend.easy :as rfe]
|
[reitit.frontend.easy :as rfe]
|
||||||
[reitit.frontend.controllers :as rfc]
|
[reitit.frontend.controllers :as rfc]
|
||||||
|
|
@ -147,6 +148,6 @@
|
||||||
(assoc state :match (assoc new-match :controllers (rfc/apply-controllers (:controllers (:match state)) new-match)))
|
(assoc state :match (assoc new-match :controllers (rfc/apply-controllers (:controllers (:match state)) new-match)))
|
||||||
(assoc state :match new-match))))))
|
(assoc state :match new-match))))))
|
||||||
{:use-fragment true})
|
{:use-fragment true})
|
||||||
(r/render [main-view] (.getElementById js/document "app")))
|
(rd/render [main-view] (.getElementById js/document "app")))
|
||||||
|
|
||||||
(init!)
|
(init!)
|
||||||
|
|
|
||||||
|
|
@ -1,23 +1,25 @@
|
||||||
(defproject frontend "0.1.0-SNAPSHOT"
|
(defproject frontend-controllers "0.1.0-SNAPSHOT"
|
||||||
:description "FIXME: write description"
|
:description "FIXME: write description"
|
||||||
:url "http://example.com/FIXME"
|
:url "http://example.com/FIXME"
|
||||||
:license {:name "Eclipse Public License"
|
:license {:name "Eclipse Public License"
|
||||||
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||||
|
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring-server "0.5.0"]
|
[ring-server "0.5.0"]
|
||||||
[reagent "0.8.1"]
|
[reagent "1.2.0"]
|
||||||
[ring "1.7.1"]
|
[ring "1.12.1"]
|
||||||
[hiccup "1.0.5"]
|
[hiccup "1.0.5"]
|
||||||
[org.clojure/clojurescript "1.10.439"]
|
[org.clojure/clojurescript "1.11.132"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/reitit-schema "0.7.0-alpha1"]
|
[metosin/reitit-schema "0.10.0"]
|
||||||
[metosin/reitit-frontend "0.7.0-alpha1"]
|
[metosin/reitit-frontend "0.10.0"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]
|
||||||
;; Just for pretty printting the match
|
;; Just for pretty printting the match
|
||||||
[fipp "0.6.14"]]
|
[fipp "0.6.14"]]
|
||||||
|
|
||||||
:plugins [[lein-cljsbuild "1.1.7"]
|
:plugins [[lein-cljsbuild "1.1.8"]
|
||||||
[lein-figwheel "0.5.18"]]
|
[lein-figwheel "0.5.20"]]
|
||||||
|
|
||||||
:source-paths []
|
:source-paths []
|
||||||
:resource-paths ["resources" "target/cljsbuild"]
|
:resource-paths ["resources" "target/cljsbuild"]
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
(ns frontend.core
|
(ns frontend.core
|
||||||
(:require [reagent.core :as r]
|
(:require [reagent.core :as r]
|
||||||
|
[reagent.dom :as rd]
|
||||||
[reitit.frontend :as rf]
|
[reitit.frontend :as rf]
|
||||||
[reitit.frontend.easy :as rfe]
|
[reitit.frontend.easy :as rfe]
|
||||||
[reitit.frontend.controllers :as rfc]
|
[reitit.frontend.controllers :as rfc]
|
||||||
|
|
@ -18,7 +19,7 @@
|
||||||
[:div
|
[:div
|
||||||
[:ul
|
[:ul
|
||||||
[:li [:a {:href (rfe/href ::item {:id 1})} "Item 1"]]
|
[:li [:a {:href (rfe/href ::item {:id 1})} "Item 1"]]
|
||||||
[:li [:a {:href (rfe/href ::item {:id 2} {:foo "bar"})} "Item 2"]]]
|
[:li [:a {:href (rfe/href ::item {:id 2} {:foo "bar"} "zzz")} "Item 2"]]]
|
||||||
(when id
|
(when id
|
||||||
[:h2 "Selected item " id])
|
[:h2 "Selected item " id])
|
||||||
[:p "Query params: " [:pre (pr-str query)]]
|
[:p "Query params: " [:pre (pr-str query)]]
|
||||||
|
|
@ -88,6 +89,6 @@
|
||||||
(if new-match
|
(if new-match
|
||||||
(assoc new-match :controllers (rfc/apply-controllers (:controllers old-match) new-match))))))
|
(assoc new-match :controllers (rfc/apply-controllers (:controllers old-match) new-match))))))
|
||||||
{:use-fragment true})
|
{:use-fragment true})
|
||||||
(r/render [current-page] (.getElementById js/document "app")))
|
(rd/render [current-page] (.getElementById js/document "app")))
|
||||||
|
|
||||||
(init!)
|
(init!)
|
||||||
|
|
|
||||||
|
|
@ -1,24 +1,26 @@
|
||||||
(defproject frontend "0.1.0-SNAPSHOT"
|
(defproject frontend-links "0.1.0-SNAPSHOT"
|
||||||
:description "FIXME: write description"
|
:description "FIXME: write description"
|
||||||
:url "http://example.com/FIXME"
|
:url "http://example.com/FIXME"
|
||||||
:license {:name "Eclipse Public License"
|
:license {:name "Eclipse Public License"
|
||||||
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||||
|
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring-server "0.5.0"]
|
[ring-server "0.5.0"]
|
||||||
[reagent "0.8.1"]
|
[reagent "1.2.0"]
|
||||||
[ring "1.7.1"]
|
[ring "1.12.1"]
|
||||||
[hiccup "1.0.5"]
|
[hiccup "1.0.5"]
|
||||||
[org.clojure/clojurescript "1.10.520"]
|
[org.clojure/clojurescript "1.10.520"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/reitit-spec "0.7.0-alpha1"]
|
[metosin/reitit-spec "0.10.0"]
|
||||||
[metosin/reitit-frontend "0.7.0-alpha1"]
|
[metosin/reitit-frontend "0.10.0"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]
|
||||||
;; Just for pretty printting the match
|
;; Just for pretty printting the match
|
||||||
[fipp "0.6.14"]]
|
[fipp "0.6.14"]]
|
||||||
|
|
||||||
:plugins [[lein-cljsbuild "1.1.7"]
|
:plugins [[lein-cljsbuild "1.1.8"]
|
||||||
[lein-figwheel "0.5.18"]
|
[lein-figwheel "0.5.20"]
|
||||||
[cider/cider-nrepl "0.21.1"]]
|
[cider/cider-nrepl "0.47.1"]]
|
||||||
|
|
||||||
:repl-options {:nrepl-middleware [cider.piggieback/wrap-cljs-repl]}
|
:repl-options {:nrepl-middleware [cider.piggieback/wrap-cljs-repl]}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
(:require [clojure.string :as string]
|
(:require [clojure.string :as string]
|
||||||
[fipp.edn :as fedn]
|
[fipp.edn :as fedn]
|
||||||
[reagent.core :as r]
|
[reagent.core :as r]
|
||||||
|
[reagent.dom :as rd]
|
||||||
[reitit.coercion.spec :as rss]
|
[reitit.coercion.spec :as rss]
|
||||||
[reitit.frontend :as rf]
|
[reitit.frontend :as rf]
|
||||||
[reitit.frontend.easy :as rfe]
|
[reitit.frontend.easy :as rfe]
|
||||||
|
|
@ -137,7 +138,7 @@
|
||||||
(fn [m] (reset! current-match m))
|
(fn [m] (reset! current-match m))
|
||||||
;; set to false to enable HistoryAPI
|
;; set to false to enable HistoryAPI
|
||||||
{:use-fragment true})
|
{:use-fragment true})
|
||||||
(r/render [current-page] (.getElementById js/document "app")))
|
(rd/render [current-page] (.getElementById js/document "app")))
|
||||||
|
|
||||||
(init!)
|
(init!)
|
||||||
|
|
||||||
|
|
|
||||||
13
examples/frontend-malli/README.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# reitit-frontend example
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```clj
|
||||||
|
> lein figwheel
|
||||||
|
```
|
||||||
|
|
||||||
|
Go with browser to http://localhost:3449
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Copyright © Metosin Oy and collaborators
|
||||||
1
examples/frontend-malli/checkouts/reitit-core
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../../../modules/reitit-core
|
||||||
1
examples/frontend-malli/checkouts/reitit-frontend
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../../../modules/reitit-frontend
|
||||||
1
examples/frontend-malli/checkouts/reitit-schema
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../../../modules/reitit-schema
|
||||||
57
examples/frontend-malli/project.clj
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
(defproject frontend-malli "0.1.0-SNAPSHOT"
|
||||||
|
:description "FIXME: write description"
|
||||||
|
:url "http://example.com/FIXME"
|
||||||
|
:license {:name "Eclipse Public License"
|
||||||
|
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||||
|
|
||||||
|
:dependencies [[org.clojure/clojure "1.10.1"]
|
||||||
|
[ring-server "0.5.0"]
|
||||||
|
[reagent "1.2.0"]
|
||||||
|
[ring "1.12.1"]
|
||||||
|
[hiccup "1.0.5"]
|
||||||
|
[org.clojure/clojurescript "1.11.132"]
|
||||||
|
[metosin/reitit "0.10.0"]
|
||||||
|
[metosin/reitit-malli "0.10.0"]
|
||||||
|
[metosin/reitit-frontend "0.10.0"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]
|
||||||
|
;; Just for pretty printting the match
|
||||||
|
[fipp "0.6.23"]]
|
||||||
|
|
||||||
|
:plugins [[lein-cljsbuild "1.1.8"]
|
||||||
|
[lein-figwheel "0.5.20"]]
|
||||||
|
|
||||||
|
:source-paths []
|
||||||
|
:resource-paths ["resources" "target/cljsbuild"]
|
||||||
|
|
||||||
|
:profiles {:dev {:dependencies [[binaryage/devtools "1.0.2"]]}}
|
||||||
|
|
||||||
|
:cljsbuild
|
||||||
|
{:builds
|
||||||
|
[{:id "app"
|
||||||
|
:figwheel true
|
||||||
|
:source-paths ["src"]
|
||||||
|
:watch-paths ["src" "checkouts/reitit-frontend/src"]
|
||||||
|
:compiler {:main "frontend.core"
|
||||||
|
:asset-path "/js/out"
|
||||||
|
:output-to "target/cljsbuild/public/js/app.js"
|
||||||
|
:output-dir "target/cljsbuild/public/js/out"
|
||||||
|
:source-map true
|
||||||
|
:optimizations :none
|
||||||
|
:pretty-print true
|
||||||
|
:preloads [devtools.preload]
|
||||||
|
:aot-cache true}}
|
||||||
|
{:id "min"
|
||||||
|
:source-paths ["src"]
|
||||||
|
:compiler {:output-to "target/cljsbuild/public/js/app.js"
|
||||||
|
:output-dir "target/cljsbuild/public/js"
|
||||||
|
:source-map "target/cljsbuild/public/js/app.js.map"
|
||||||
|
:optimizations :advanced
|
||||||
|
:pretty-print false
|
||||||
|
:aot-cache true}}]}
|
||||||
|
|
||||||
|
:figwheel {:http-server-root "public"
|
||||||
|
:server-port 3449
|
||||||
|
:nrepl-port 7002
|
||||||
|
;; Server index.html for all routes for HTML5 routing
|
||||||
|
:ring-handler backend.server/handler})
|
||||||
10
examples/frontend-malli/resources/public/index.html
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Reitit frontend example</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="app"></div>
|
||||||
|
<script src="/js/app.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
10
examples/frontend-malli/src/backend/server.clj
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
(ns backend.server
|
||||||
|
(:require [ring.util.response :as resp]
|
||||||
|
[ring.middleware.content-type :as content-type]))
|
||||||
|
|
||||||
|
(def handler
|
||||||
|
(-> (fn [request]
|
||||||
|
(or (resp/resource-response (:uri request) {:root "public"})
|
||||||
|
(-> (resp/resource-response "index.html" {:root "public"})
|
||||||
|
(resp/content-type "text/html"))))
|
||||||
|
content-type/wrap-content-type))
|
||||||
84
examples/frontend-malli/src/frontend/core.cljs
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
(ns frontend.core
|
||||||
|
(:require [reagent.core :as r]
|
||||||
|
[reagent.dom :as rd]
|
||||||
|
[reitit.frontend :as rf]
|
||||||
|
[reitit.frontend.easy :as rfe]
|
||||||
|
[reitit.coercion.malli :as rsm]
|
||||||
|
[fipp.edn :as fedn]))
|
||||||
|
|
||||||
|
(defn home-page []
|
||||||
|
[:div
|
||||||
|
[:h2 "Welcome to frontend"]
|
||||||
|
|
||||||
|
[:button
|
||||||
|
{:type "button"
|
||||||
|
:on-click #(rfe/push-state ::item {:id 3})}
|
||||||
|
"Item 3"]
|
||||||
|
|
||||||
|
[:button
|
||||||
|
{:type "button"
|
||||||
|
:on-click #(rfe/replace-state ::item {:id 4})}
|
||||||
|
"Replace State Item 4"]])
|
||||||
|
|
||||||
|
(defn about-page []
|
||||||
|
[:div
|
||||||
|
[:h2 "About frontend"]
|
||||||
|
[:ul
|
||||||
|
[:li [:a {:href "http://google.com"} "external link"]]
|
||||||
|
[:li [:a {:href (rfe/href ::foobar)} "Missing route"]]
|
||||||
|
[:li [:a {:href (rfe/href ::item)} "Missing route params"]]]
|
||||||
|
|
||||||
|
[:div
|
||||||
|
{:content-editable true
|
||||||
|
:suppressContentEditableWarning true}
|
||||||
|
[:p "Link inside contentEditable element is ignored."]
|
||||||
|
[:a {:href (rfe/href ::frontpage)} "Link"]]])
|
||||||
|
|
||||||
|
(defn item-page [match]
|
||||||
|
(let [{:keys [path query]} (:parameters match)
|
||||||
|
{:keys [id]} path]
|
||||||
|
[:div
|
||||||
|
[:h2 "Selected item " id]
|
||||||
|
(if (:foo query)
|
||||||
|
[:p "Optional foo query param: " (:foo query)])]))
|
||||||
|
|
||||||
|
(defonce match (r/atom nil))
|
||||||
|
|
||||||
|
(defn current-page []
|
||||||
|
[:div
|
||||||
|
[:ul
|
||||||
|
[:li [:a {:href (rfe/href ::frontpage)} "Frontpage"]]
|
||||||
|
[:li [:a {:href (rfe/href ::about)} "About"]]
|
||||||
|
[:li [:a {:href (rfe/href ::item {:id 1})} "Item 1"]]
|
||||||
|
[:li [:a {:href (rfe/href ::item {:id 2} {:foo "bar"})} "Item 2"]]]
|
||||||
|
(if @match
|
||||||
|
(let [view (:view (:data @match))]
|
||||||
|
[view @match]))
|
||||||
|
[:pre (with-out-str (fedn/pprint @match))]])
|
||||||
|
|
||||||
|
(def routes
|
||||||
|
[["/"
|
||||||
|
{:name ::frontpage
|
||||||
|
:view home-page}]
|
||||||
|
|
||||||
|
["/about"
|
||||||
|
{:name ::about
|
||||||
|
:view about-page}]
|
||||||
|
|
||||||
|
["/item/:id"
|
||||||
|
{:name ::item
|
||||||
|
:view item-page
|
||||||
|
:parameters {:path [:map
|
||||||
|
[:id :int]]
|
||||||
|
:query [:map
|
||||||
|
[:foo {:optional true} :keyword]]}}]])
|
||||||
|
|
||||||
|
(defn init! []
|
||||||
|
(rfe/start!
|
||||||
|
(rf/router routes {:data {:coercion rsm/coercion}})
|
||||||
|
(fn [m] (reset! match m))
|
||||||
|
;; set to false to enable HistoryAPI
|
||||||
|
{:use-fragment true})
|
||||||
|
(rd/render [current-page] (.getElementById js/document "app")))
|
||||||
|
|
||||||
|
(init!)
|
||||||
|
|
@ -1,24 +1,27 @@
|
||||||
(defproject frontend "0.1.0-SNAPSHOT"
|
(defproject frontend-prompt "0.1.0-SNAPSHOT"
|
||||||
:description "FIXME: write description"
|
:description "FIXME: write description"
|
||||||
:url "http://example.com/FIXME"
|
:url "http://example.com/FIXME"
|
||||||
:license {:name "Eclipse Public License"
|
:license {:name "Eclipse Public License"
|
||||||
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||||
|
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring-server "0.5.0"]
|
[ring-server "0.5.0"]
|
||||||
[reagent "0.8.1"]
|
[reagent "1.2.0"]
|
||||||
[ring "1.7.1"]
|
[ring "1.12.1"]
|
||||||
[hiccup "1.0.5"]
|
[hiccup "1.0.5"]
|
||||||
[org.clojure/clojurescript "1.10.520"]
|
[org.clojure/clojurescript "1.11.132"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/reitit-spec "0.7.0-alpha1"]
|
[metosin/reitit-spec "0.10.0"]
|
||||||
[metosin/reitit-frontend "0.7.0-alpha1"]
|
[metosin/reitit-frontend "0.10.0"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]
|
||||||
;; Just for pretty printting the match
|
;; Just for pretty printting the match
|
||||||
[fipp "0.6.14"]]
|
[fipp "0.6.23"]]
|
||||||
|
|
||||||
|
:plugins [[lein-cljsbuild "1.1.8"]
|
||||||
|
[lein-figwheel "0.5.20"]
|
||||||
|
[cider/cider-nrepl "0.47.1"]]
|
||||||
|
|
||||||
:plugins [[lein-cljsbuild "1.1.7"]
|
|
||||||
[lein-figwheel "0.5.18"]
|
|
||||||
[cider/cider-nrepl "0.21.1"]]
|
|
||||||
|
|
||||||
:repl-options {:nrepl-middleware [cider.piggieback/wrap-cljs-repl]}
|
:repl-options {:nrepl-middleware [cider.piggieback/wrap-cljs-repl]}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
(ns frontend.core
|
(ns frontend.core
|
||||||
(:require [fipp.edn :as fedn]
|
(:require [fipp.edn :as fedn]
|
||||||
[reagent.core :as r]
|
[reagent.core :as r]
|
||||||
|
[reagent.dom :as rd]
|
||||||
[reitit.coercion.spec :as rss]
|
[reitit.coercion.spec :as rss]
|
||||||
[reitit.frontend :as rf]
|
[reitit.frontend :as rf]
|
||||||
[reitit.frontend.easy :as rfe]))
|
[reitit.frontend.easy :as rfe]))
|
||||||
|
|
@ -63,6 +64,6 @@
|
||||||
on-navigate
|
on-navigate
|
||||||
;; set to false to enable HistoryAPI
|
;; set to false to enable HistoryAPI
|
||||||
{:use-fragment true})
|
{:use-fragment true})
|
||||||
(r/render [current-page] (.getElementById js/document "app")))
|
(rd/render [current-page] (.getElementById js/document "app")))
|
||||||
|
|
||||||
(init!)
|
(init!)
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,15 @@
|
||||||
(defproject frontend-re-frame "0.1.0-SNAPSHOT"
|
(defproject frontend-re-frame "0.1.0-SNAPSHOT"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[org.clojure/clojurescript "1.10.520"]
|
[org.clojure/clojurescript "1.11.132"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[reagent "0.8.1"]
|
[reagent "1.2.0"]
|
||||||
[re-frame "0.10.6"]]
|
[re-frame "0.10.6"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]]
|
||||||
|
|
||||||
:plugins [[lein-cljsbuild "1.1.7"]
|
:plugins [[lein-cljsbuild "1.1.8"]
|
||||||
[lein-figwheel "0.5.18"]
|
[lein-figwheel "0.5.20"]
|
||||||
[cider/cider-nrepl "0.21.1"]]
|
[cider/cider-nrepl "0.47.1"]]
|
||||||
|
|
||||||
:repl-options {:nrepl-middleware [cider.piggieback/wrap-cljs-repl]}
|
:repl-options {:nrepl-middleware [cider.piggieback/wrap-cljs-repl]}
|
||||||
:min-lein-version "2.5.3"
|
:min-lein-version "2.5.3"
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
(ns frontend-re-frame.core
|
(ns frontend-re-frame.core
|
||||||
(:require [re-frame.core :as re-frame]
|
(:require [re-frame.core :as re-frame]
|
||||||
[reagent.core :as reagent]
|
[reagent.dom :as rd]
|
||||||
[reitit.core :as r]
|
[reitit.core :as r]
|
||||||
[reitit.coercion.spec :as rss]
|
[reitit.coercion.spec :as rss]
|
||||||
[reitit.frontend :as rf]
|
[reitit.frontend :as rf]
|
||||||
|
|
@ -143,7 +143,7 @@
|
||||||
(re-frame/dispatch-sync [::initialize-db])
|
(re-frame/dispatch-sync [::initialize-db])
|
||||||
(dev-setup)
|
(dev-setup)
|
||||||
(init-routes!) ;; Reset routes on figwheel reload
|
(init-routes!) ;; Reset routes on figwheel reload
|
||||||
(reagent/render [router-component {:router router}]
|
(rd/render [router-component {:router router}]
|
||||||
(.getElementById js/document "app")))
|
(.getElementById js/document "app")))
|
||||||
|
|
||||||
(init)
|
(init)
|
||||||
|
|
|
||||||
|
|
@ -4,15 +4,17 @@
|
||||||
:license {:name "Eclipse Public License"
|
:license {:name "Eclipse Public License"
|
||||||
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||||
|
|
||||||
:dependencies [[org.clojure/clojure "1.10.1"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring-server "0.5.0"]
|
[ring-server "0.5.0"]
|
||||||
[reagent "0.10.0"]
|
[reagent "1.2.0"]
|
||||||
[ring "1.8.1"]
|
[ring "1.12.1"]
|
||||||
[hiccup "1.0.5"]
|
[hiccup "1.0.5"]
|
||||||
[org.clojure/clojurescript "1.10.773"]
|
[org.clojure/clojurescript "1.11.132"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/reitit-spec "0.7.0-alpha1"]
|
[metosin/reitit-spec "0.10.0"]
|
||||||
[metosin/reitit-frontend "0.7.0-alpha1"]
|
[metosin/reitit-frontend "0.10.0"]
|
||||||
|
[cljsjs/react "17.0.2-0"]
|
||||||
|
[cljsjs/react-dom "17.0.2-0"]
|
||||||
;; Just for pretty printting the match
|
;; Just for pretty printting the match
|
||||||
[fipp "0.6.23"]]
|
[fipp "0.6.23"]]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
(ns frontend.core
|
(ns frontend.core
|
||||||
(:require [reagent.core :as r]
|
(:require [reagent.core :as r]
|
||||||
|
[reagent.dom :as rd]
|
||||||
[reitit.frontend :as rf]
|
[reitit.frontend :as rf]
|
||||||
[reitit.frontend.easy :as rfe]
|
[reitit.frontend.easy :as rfe]
|
||||||
[reitit.coercion.spec :as rss]
|
[reitit.coercion.spec :as rss]
|
||||||
|
|
@ -77,6 +78,6 @@
|
||||||
(fn [m] (reset! match m))
|
(fn [m] (reset! match m))
|
||||||
;; set to false to enable HistoryAPI
|
;; set to false to enable HistoryAPI
|
||||||
{:use-fragment true})
|
{:use-fragment true})
|
||||||
(r/render [current-page] (.getElementById js/document "app")))
|
(rd/render [current-page] (.getElementById js/document "app")))
|
||||||
|
|
||||||
(init!)
|
(init!)
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject http-swagger "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Http App with Swagger"
|
:description "Reitit Http App with Swagger"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[aleph "0.4.7-alpha5"]
|
[aleph "0.7.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/ring-swagger-ui "5.0.0-alpha.0"]]
|
[metosin/ring-swagger-ui "5.9.0"]]
|
||||||
:repl-options {:init-ns example.server})
|
:repl-options {:init-ns example.server})
|
||||||
|
|
|
||||||
|
|
@ -62,7 +62,7 @@
|
||||||
:handler (openapi/create-openapi-handler)}}]
|
:handler (openapi/create-openapi-handler)}}]
|
||||||
|
|
||||||
["/files"
|
["/files"
|
||||||
{:tags ["files"]}
|
{:tags #{"files"}}
|
||||||
|
|
||||||
["/upload"
|
["/upload"
|
||||||
{:post {:summary "upload a file"
|
{:post {:summary "upload a file"
|
||||||
|
|
@ -77,7 +77,7 @@
|
||||||
{:get {:summary "downloads a file"
|
{:get {:summary "downloads a file"
|
||||||
:swagger {:produces ["image/png"]}
|
:swagger {:produces ["image/png"]}
|
||||||
:responses {200 {:description "an image"
|
:responses {200 {:description "an image"
|
||||||
:content {"image/png" any?}}}
|
:content {"image/png" {:schema any?}}}}
|
||||||
:handler (fn [_]
|
:handler (fn [_]
|
||||||
{:status 200
|
{:status 200
|
||||||
:headers {"Content-Type" "image/png"}
|
:headers {"Content-Type" "image/png"}
|
||||||
|
|
@ -85,7 +85,7 @@
|
||||||
(io/resource "reitit.png"))})}}]]
|
(io/resource "reitit.png"))})}}]]
|
||||||
|
|
||||||
["/async"
|
["/async"
|
||||||
{:get {:tags ["async"]
|
{:get {:tags #{"async"}
|
||||||
:summary "fetches random users asynchronously over the internet"
|
:summary "fetches random users asynchronously over the internet"
|
||||||
:parameters {:query (s/keys :req-un [::results] :opt-un [::seed])}
|
:parameters {:query (s/keys :req-un [::results] :opt-un [::seed])}
|
||||||
:responses {200 {:body any?}}
|
:responses {200 {:body any?}}
|
||||||
|
|
@ -102,7 +102,7 @@
|
||||||
:body results})))}}]
|
:body results})))}}]
|
||||||
|
|
||||||
["/math"
|
["/math"
|
||||||
{:tags ["math"]}
|
{:tags #{"math"}}
|
||||||
|
|
||||||
["/plus"
|
["/plus"
|
||||||
{:get {:summary "plus with data-spec query parameters"
|
{:get {:summary "plus with data-spec query parameters"
|
||||||
|
|
@ -112,22 +112,6 @@
|
||||||
{:status 200
|
{:status 200
|
||||||
:body {:total (+ x y)}})}
|
:body {:total (+ x y)}})}
|
||||||
:post {:summary "plus with data-spec body parameters"
|
:post {:summary "plus with data-spec body parameters"
|
||||||
;; OpenAPI3 named examples for request & response
|
|
||||||
:openapi {:requestBody
|
|
||||||
{:content
|
|
||||||
{"application/json"
|
|
||||||
{:examples {"add-one-one" {:summary "1+1"
|
|
||||||
:value {:x 1 :y 1}}
|
|
||||||
"add-one-two" {:summary "1+2"
|
|
||||||
:value {:x 1 :y 2}}}}}}
|
|
||||||
:responses
|
|
||||||
{200
|
|
||||||
{:content
|
|
||||||
{"application/json"
|
|
||||||
{:examples {"two" {:summary "2"
|
|
||||||
:value {:total 2}}
|
|
||||||
"three" {:summary "3"
|
|
||||||
:value {:total 3}}}}}}}}
|
|
||||||
:parameters {:body {:x int?, :y int?}}
|
:parameters {:body {:x int?, :y int?}}
|
||||||
:responses {200 {:body {:total int?}}}
|
:responses {200 {:body {:total int?}}}
|
||||||
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
||||||
|
|
@ -148,7 +132,7 @@
|
||||||
{:status 200
|
{:status 200
|
||||||
:body {:total (- x y)}})}}]]
|
:body {:total (- x y)}})}}]]
|
||||||
["/secure"
|
["/secure"
|
||||||
{:tags ["secure"]
|
{:tags #{"secure"}
|
||||||
:openapi {:security [{"auth" []}]}
|
:openapi {:security [{"auth" []}]}
|
||||||
:swagger {:security [{"auth" []}]}}
|
:swagger {:security [{"auth" []}]}}
|
||||||
["/get"
|
["/get"
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject http "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Ring App with Swagger"
|
:description "Reitit Ring App with Swagger"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[org.clojure/core.async "0.4.490"]
|
[org.clojure/core.async "1.6.681"]
|
||||||
[funcool/promesa "1.9.0"]
|
[funcool/promesa "11.0.678"]
|
||||||
[manifold "0.1.8"]
|
[manifold "0.4.2"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]]
|
||||||
:repl-options {:init-ns example.server})
|
:repl-options {:init-ns example.server})
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
(defproject just-coercion-with-ring "0.1.0-SNAPSHOT"
|
(defproject just-coercion-with-ring "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit coercion with vanilla ring"
|
:description "Reitit coercion with vanilla ring"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]])
|
[metosin/reitit "0.10.0"]])
|
||||||
|
|
|
||||||
18
examples/openapi/README.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# OpenAPI 3 feature showcase
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```clj
|
||||||
|
> lein repl
|
||||||
|
(start)
|
||||||
|
```
|
||||||
|
|
||||||
|
- Swagger UI served at <http://localhost:3000/>
|
||||||
|
- Openapi spec served at <http://localhost:3000/openapi.json>
|
||||||
|
- See [src/example/server.clj](src/example/server.clj) for details
|
||||||
|
|
||||||
|
<img src="https://raw.githubusercontent.com/metosin/reitit/master/examples/openapi/openapi.png" />
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Copyright © 2023 Metosin Oy
|
||||||
BIN
examples/openapi/openapi.png
Normal file
|
After Width: | Height: | Size: 137 KiB |
10
examples/openapi/project.clj
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
(defproject openapi "0.1.0-SNAPSHOT"
|
||||||
|
:description "Reitit OpenAPI example"
|
||||||
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
|
[metosin/jsonista "0.3.8"]
|
||||||
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
|
[metosin/reitit "0.10.0"]
|
||||||
|
[metosin/ring-swagger-ui "5.9.0"]
|
||||||
|
[org.slf4j/slf4j-simple "2.0.9"]]
|
||||||
|
:repl-options {:init-ns example.server}
|
||||||
|
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||||
227
examples/openapi/src/example/server.clj
Normal file
|
|
@ -0,0 +1,227 @@
|
||||||
|
(ns example.server
|
||||||
|
(:require [reitit.ring :as ring]
|
||||||
|
[reitit.ring.spec]
|
||||||
|
[reitit.coercion.malli]
|
||||||
|
[reitit.openapi :as openapi]
|
||||||
|
[reitit.ring.malli]
|
||||||
|
[reitit.swagger-ui :as swagger-ui]
|
||||||
|
[reitit.ring.coercion :as coercion]
|
||||||
|
[reitit.dev.pretty :as pretty]
|
||||||
|
[reitit.ring.middleware.muuntaja :as muuntaja]
|
||||||
|
[reitit.ring.middleware.exception :as exception]
|
||||||
|
[reitit.ring.middleware.multipart :as multipart]
|
||||||
|
[reitit.ring.middleware.parameters :as parameters]
|
||||||
|
[ring.adapter.jetty :as jetty]
|
||||||
|
[muuntaja.core :as m]))
|
||||||
|
|
||||||
|
(def Transaction
|
||||||
|
[:map
|
||||||
|
[:amount :double]
|
||||||
|
[:from :string]])
|
||||||
|
|
||||||
|
(def AccountId
|
||||||
|
[:map
|
||||||
|
[:bank :string]
|
||||||
|
[:id :string]])
|
||||||
|
|
||||||
|
(def Account
|
||||||
|
[:map
|
||||||
|
[:bank :string]
|
||||||
|
[:id :string]
|
||||||
|
[:balance :double]
|
||||||
|
[:transactions [:vector #'Transaction]]])
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
(def app
|
||||||
|
(ring/ring-handler
|
||||||
|
(ring/router
|
||||||
|
[["/openapi.json"
|
||||||
|
{:get {:no-doc true
|
||||||
|
:openapi {:info {:title "my-api"
|
||||||
|
:description "openapi3 docs with [malli](https://github.com/metosin/malli) and reitit-ring"
|
||||||
|
:version "0.0.1"}
|
||||||
|
;; used in /secure APIs below
|
||||||
|
:components {:securitySchemes {"auth" {:type :apiKey
|
||||||
|
:in :header
|
||||||
|
:name "Example-Api-Key"}}}}
|
||||||
|
:handler (openapi/create-openapi-handler)}}]
|
||||||
|
|
||||||
|
["/pizza"
|
||||||
|
{:get {:summary "Fetch a pizza | Multiple content-types, multiple examples"
|
||||||
|
:responses {200 {:description "Fetch a pizza as json or EDN"
|
||||||
|
:content {"application/json" {:schema [:map
|
||||||
|
[:format [:enum :json]]
|
||||||
|
[:color :keyword]
|
||||||
|
[:pineapple :boolean]]
|
||||||
|
:examples {:white {:description "White pizza with pineapple"
|
||||||
|
:value {:format :json
|
||||||
|
:color :white
|
||||||
|
:pineapple true}}
|
||||||
|
:red {:description "Red pizza"
|
||||||
|
:value {:format :json
|
||||||
|
:color :red
|
||||||
|
:pineapple false}}}}
|
||||||
|
"application/edn" {:schema [:map
|
||||||
|
[:format [:enum :edn]]
|
||||||
|
[:color :keyword]
|
||||||
|
[:pineapple :boolean]]
|
||||||
|
:examples {:red {:description "Red pizza with pineapple"
|
||||||
|
:value (pr-str {:format :edn :color :red :pineapple true})}}}}}}
|
||||||
|
:handler (fn [_request]
|
||||||
|
(rand-nth [{:status 200
|
||||||
|
:muuntaja/content-type "application/json"
|
||||||
|
:body {:format :json
|
||||||
|
:color :red
|
||||||
|
:pineapple true}}
|
||||||
|
{:status 200
|
||||||
|
:muuntaja/content-type "application/edn"
|
||||||
|
:body {:format :edn
|
||||||
|
:color :red
|
||||||
|
:pineapple true}}]))}
|
||||||
|
:post {:summary "Create a pizza | Multiple content-types, multiple examples | Default response schema"
|
||||||
|
:request {:description "Create a pizza using json or EDN"
|
||||||
|
:content {"application/json" {:schema [:map
|
||||||
|
[:color :keyword]
|
||||||
|
[:pineapple :boolean]]
|
||||||
|
:examples {:purple {:value {:color :purple
|
||||||
|
:pineapple false}}}}
|
||||||
|
"application/edn" {:schema [:map
|
||||||
|
[:color :keyword]
|
||||||
|
[:pineapple :boolean]]
|
||||||
|
:examples {:purple {:value (pr-str {:color :purple
|
||||||
|
:pineapple false})}}}}}
|
||||||
|
:responses {200 {:description "Success"
|
||||||
|
:content {:default {:schema [:map [:success :boolean]]
|
||||||
|
:example {:success true}}}}
|
||||||
|
:default {:description "Not success"
|
||||||
|
:content {:default {:schema [:map [:error :string]]
|
||||||
|
:example {:error "error"}}}}}
|
||||||
|
:handler (fn [_request]
|
||||||
|
(if (< (Math/random) 0.5)
|
||||||
|
{:status 200
|
||||||
|
:body {:success true}}
|
||||||
|
{:status 500
|
||||||
|
:body {:error "an error happened"}}))}}]
|
||||||
|
|
||||||
|
|
||||||
|
["/contact"
|
||||||
|
{:get {:summary "Search for a contact | Customizing via malli properties"
|
||||||
|
:parameters {:query [:map
|
||||||
|
[:limit {:title "How many results to return? Optional."
|
||||||
|
:optional true
|
||||||
|
:json-schema/default 30
|
||||||
|
:json-schema/example 10}
|
||||||
|
int?]
|
||||||
|
[:charset {:title "Which charset to use?"
|
||||||
|
:optional true
|
||||||
|
:json-schema/deprecated true}
|
||||||
|
string?]
|
||||||
|
[:email {:title "Email address to search for"
|
||||||
|
:json-schema/format "email"}
|
||||||
|
string?]]}
|
||||||
|
:responses {200 {:content {:default {:schema [:vector
|
||||||
|
[:map
|
||||||
|
[:name {:json-schema/example "Heidi"}
|
||||||
|
string?]
|
||||||
|
[:email {:json-schema/example "heidi@alps.ch"}
|
||||||
|
string?]]]}}}}
|
||||||
|
:handler (fn [_request]
|
||||||
|
{:status 200
|
||||||
|
:body [{:name "Heidi"
|
||||||
|
:email "heidi@alps.ch"}]})}}]
|
||||||
|
|
||||||
|
["/account"
|
||||||
|
{:get {:summary "Fetch an account | Recursive schemas using malli registry, link to external docs"
|
||||||
|
:parameters {:query #'AccountId}
|
||||||
|
:responses {200 {:content {:default {:schema #'Account}}}}
|
||||||
|
:openapi {:externalDocs {:description "The reitit repository"
|
||||||
|
:url "https://github.com/metosin/reitit"}}
|
||||||
|
:handler (fn [_request]
|
||||||
|
{:status 200
|
||||||
|
:body {:bank "MiniBank"
|
||||||
|
:id "0001"
|
||||||
|
:balance 13.5
|
||||||
|
:transactions [{:from "0002"
|
||||||
|
:amount 20.0}
|
||||||
|
{:from "0003"
|
||||||
|
:amount -6.5}]}})}}]
|
||||||
|
|
||||||
|
["/complex"
|
||||||
|
{:post {:summary "Complex schema with :multi, :enum, :tuple etc."
|
||||||
|
:request {:content
|
||||||
|
{:default
|
||||||
|
{:schema [:map
|
||||||
|
[:vector-of-tuples [:vector [:tuple :string :int]]]
|
||||||
|
[:regex [:re "[0-9]+"]]
|
||||||
|
[:enum [:enum 1 3 5 42]]
|
||||||
|
[:multi [:multi {:dispatch :type}
|
||||||
|
["literal" [:map
|
||||||
|
[:type [:= "literal"]]
|
||||||
|
[:value [:or :int :string]]]]
|
||||||
|
["reference" [:map
|
||||||
|
[:type [:= "reference"]]
|
||||||
|
[:description :string]
|
||||||
|
[:ref :uuid]]]]]]
|
||||||
|
:example {:vector-of-tuples [["a" 1] ["b" 2]]
|
||||||
|
:regex "01234"
|
||||||
|
:enum 5
|
||||||
|
:multi {:type "literal"
|
||||||
|
:value "x"}}}}}
|
||||||
|
:responses {200 {:content {:default {:schema [:map-of :keyword :any]}}}}
|
||||||
|
:handler (fn [request]
|
||||||
|
{:status 200
|
||||||
|
:body (get-in request [:parameters :request])})}}]
|
||||||
|
|
||||||
|
["/secure"
|
||||||
|
{:tags #{"secure"}
|
||||||
|
:openapi {:security [{"auth" []}]}}
|
||||||
|
["/get"
|
||||||
|
{:get {:summary "endpoint authenticated with a header"
|
||||||
|
:responses {200 {:body [:map [:secret :string]]}
|
||||||
|
401 {:body [:map [:error :string]]}}
|
||||||
|
:handler (fn [request]
|
||||||
|
;; In a real app authentication would be handled by middleware
|
||||||
|
(if (= "secret" (get-in request [:headers "example-api-key"]))
|
||||||
|
{:status 200
|
||||||
|
:body {:secret "I am a marmot"}}
|
||||||
|
{:status 401
|
||||||
|
:body {:error "unauthorized"}}))}}]]]
|
||||||
|
|
||||||
|
{;;:reitit.middleware/transform dev/print-request-diffs ;; pretty diffs
|
||||||
|
:validate reitit.ring.spec/validate
|
||||||
|
:exception pretty/exception
|
||||||
|
:data {:coercion reitit.coercion.malli/coercion
|
||||||
|
:muuntaja m/instance
|
||||||
|
:middleware [openapi/openapi-feature
|
||||||
|
;; query-params & form-params
|
||||||
|
parameters/parameters-middleware
|
||||||
|
;; content-negotiation
|
||||||
|
muuntaja/format-negotiate-middleware
|
||||||
|
;; encoding response body
|
||||||
|
muuntaja/format-response-middleware
|
||||||
|
;; exception handling
|
||||||
|
exception/exception-middleware
|
||||||
|
;; decoding request body
|
||||||
|
muuntaja/format-request-middleware
|
||||||
|
;; coercing response bodys
|
||||||
|
coercion/coerce-response-middleware
|
||||||
|
;; coercing request parameters
|
||||||
|
coercion/coerce-request-middleware
|
||||||
|
;; multipart
|
||||||
|
multipart/multipart-middleware]}})
|
||||||
|
(ring/routes
|
||||||
|
(swagger-ui/create-swagger-ui-handler
|
||||||
|
{:path "/"
|
||||||
|
:config {:validatorUrl nil
|
||||||
|
:urls [{:name "openapi", :url "openapi.json"}]
|
||||||
|
:urls.primaryName "openapi"
|
||||||
|
:operationsSorter "alpha"}})
|
||||||
|
(ring/create-default-handler))))
|
||||||
|
|
||||||
|
(defn start []
|
||||||
|
(jetty/run-jetty #'app {:port 3000, :join? false})
|
||||||
|
(println "server running in port 3000"))
|
||||||
|
|
||||||
|
(comment
|
||||||
|
(start))
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
(defproject pedestal-malli-swagger-example "0.1.0-SNAPSHOT"
|
(defproject pedestal-malli-swagger-example "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit-http with pedestal"
|
:description "Reitit-http with pedestal"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[io.pedestal/pedestal.service "0.5.5"]
|
[io.pedestal/pedestal.service "0.6.3"]
|
||||||
[io.pedestal/pedestal.jetty "0.5.5"]
|
[io.pedestal/pedestal.jetty "0.6.3"]
|
||||||
[metosin/reitit-malli "0.7.0-alpha1"]
|
[metosin/reitit-malli "0.10.0"]
|
||||||
[metosin/reitit-pedestal "0.7.0-alpha1"]
|
[metosin/reitit-pedestal "0.10.0"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]]
|
||||||
:repl-options {:init-ns server})
|
:repl-options {:init-ns server})
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
(ns example.server
|
(ns server
|
||||||
(:require [clojure.java.io :as io]
|
(:require [clojure.java.io :as io]
|
||||||
[io.pedestal.http.route]
|
[io.pedestal.http.route]
|
||||||
[reitit.interceptor]
|
[reitit.interceptor]
|
||||||
|
|
@ -161,4 +161,4 @@
|
||||||
(->> (reset! server)))
|
(->> (reset! server)))
|
||||||
(println "server running in port 3000"))
|
(println "server running in port 3000"))
|
||||||
|
|
||||||
#_(start server config)
|
#_(start server config)
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit-http with pedestal"
|
:description "Reitit-http with pedestal"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[io.pedestal/pedestal.service "0.5.5"]
|
[io.pedestal/pedestal.service "0.6.3"]
|
||||||
[io.pedestal/pedestal.jetty "0.5.5"]
|
[io.pedestal/pedestal.jetty "0.6.3"]
|
||||||
[metosin/reitit-pedestal "0.7.0-alpha1"]
|
[metosin/reitit-pedestal "0.10.0"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]]
|
||||||
:repl-options {:init-ns example.server})
|
:repl-options {:init-ns example.server})
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject pedestal-example "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit-http with pedestal"
|
:description "Reitit-http with pedestal"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[io.pedestal/pedestal.service "0.5.5"]
|
[io.pedestal/pedestal.service "0.6.3"]
|
||||||
[io.pedestal/pedestal.jetty "0.5.5"]
|
[io.pedestal/pedestal.jetty "0.6.3"]
|
||||||
[metosin/reitit-pedestal "0.7.0-alpha1"]
|
[metosin/reitit-pedestal "0.10.0"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]]
|
||||||
:repl-options {:init-ns example.server})
|
:repl-options {:init-ns example.server})
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Ring App"
|
:description "Reitit Ring App"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]]
|
||||||
:repl-options {:init-ns example.server})
|
:repl-options {:init-ns example.server})
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
(defproject ring-integrant-example "0.1.0-SNAPSHOT"
|
(defproject ring-integrant-example "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Ring App with Integrant"
|
:description "Reitit Ring App with Integrant"
|
||||||
:dependencies [[org.clojure/clojure "1.10.1"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[integrant "0.7.0"]]
|
[integrant "0.8.1"]]
|
||||||
:main example.server
|
:main example.server
|
||||||
:repl-options {:init-ns user}
|
:repl-options {:init-ns user}
|
||||||
:profiles {:dev {:dependencies [[integrant/repl "0.3.1"]]
|
:profiles {:dev {:dependencies [[integrant/repl "0.3.3"]]
|
||||||
:source-paths ["dev"]}})
|
:source-paths ["dev"]}})
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject ring-malli-lite-swagger "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Ring App with Swagger"
|
:description "Reitit Ring App with Swagger"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[metosin/jsonista "0.2.6"]
|
[metosin/jsonista "0.3.8"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]]
|
||||||
:repl-options {:init-ns example.server}
|
:repl-options {:init-ns example.server}
|
||||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.3.2"]]}})
|
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||||
|
|
|
||||||
|
|
@ -83,7 +83,7 @@
|
||||||
:error-keys #{#_:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
:error-keys #{#_:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
||||||
;; schema identity function (default: close all map schemas)
|
;; schema identity function (default: close all map schemas)
|
||||||
:compile mu/closed-schema
|
:compile mu/closed-schema
|
||||||
;; strip-extra-keys (effects only predefined transformers)
|
;; strip-extra-keys (affects only predefined transformers)
|
||||||
:strip-extra-keys true
|
:strip-extra-keys true
|
||||||
;; add/set default values
|
;; add/set default values
|
||||||
:default-values true
|
:default-values true
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# reitit-ring, malli, swagger
|
# reitit-ring, malli, swagger, openapi 3
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject ring-malli-swagger "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Ring App with Swagger"
|
:description "Reitit Ring App with Swagger"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[metosin/jsonista "0.2.6"]
|
[metosin/jsonista "0.3.8"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]
|
[metosin/reitit "0.10.0"]
|
||||||
[metosin/ring-swagger-ui "5.0.0-alpha.0"]]
|
[metosin/ring-swagger-ui "5.9.0"]]
|
||||||
:repl-options {:init-ns example.server}
|
:repl-options {:init-ns example.server}
|
||||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.3.2"]]}})
|
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@
|
||||||
[reitit.ring.middleware.multipart :as multipart]
|
[reitit.ring.middleware.multipart :as multipart]
|
||||||
[reitit.ring.middleware.parameters :as parameters]
|
[reitit.ring.middleware.parameters :as parameters]
|
||||||
; [reitit.ring.middleware.dev :as dev]
|
; [reitit.ring.middleware.dev :as dev]
|
||||||
; [reitit.ring.spec :as spec]
|
[reitit.ring.spec :as spec]
|
||||||
; [spec-tools.spell :as spell]
|
; [spec-tools.spell :as spell]
|
||||||
[ring.adapter.jetty :as jetty]
|
[ring.adapter.jetty :as jetty]
|
||||||
[muuntaja.core :as m]
|
[muuntaja.core :as m]
|
||||||
|
|
@ -27,6 +27,10 @@
|
||||||
:swagger {:info {:title "my-api"
|
:swagger {:info {:title "my-api"
|
||||||
:description "swagger docs with [malli](https://github.com/metosin/malli) and reitit-ring"
|
:description "swagger docs with [malli](https://github.com/metosin/malli) and reitit-ring"
|
||||||
:version "0.0.1"}
|
:version "0.0.1"}
|
||||||
|
;; used in /secure APIs below
|
||||||
|
:securityDefinitions {"auth" {:type :apiKey
|
||||||
|
:in :header
|
||||||
|
:name "Example-Api-Key"}}
|
||||||
:tags [{:name "files", :description "file api"}
|
:tags [{:name "files", :description "file api"}
|
||||||
{:name "math", :description "math api"}]}
|
{:name "math", :description "math api"}]}
|
||||||
:handler (swagger/create-swagger-handler)}}]
|
:handler (swagger/create-swagger-handler)}}]
|
||||||
|
|
@ -34,11 +38,15 @@
|
||||||
{:get {:no-doc true
|
{:get {:no-doc true
|
||||||
:openapi {:info {:title "my-api"
|
:openapi {:info {:title "my-api"
|
||||||
:description "openapi3 docs with [malli](https://github.com/metosin/malli) and reitit-ring"
|
:description "openapi3 docs with [malli](https://github.com/metosin/malli) and reitit-ring"
|
||||||
:version "0.0.1"}}
|
:version "0.0.1"}
|
||||||
|
;; used in /secure APIs below
|
||||||
|
:components {:securitySchemes {"auth" {:type :apiKey
|
||||||
|
:in :header
|
||||||
|
:name "Example-Api-Key"}}}}
|
||||||
:handler (openapi/create-openapi-handler)}}]
|
:handler (openapi/create-openapi-handler)}}]
|
||||||
|
|
||||||
["/files"
|
["/files"
|
||||||
{:tags ["files"]}
|
{:tags #{"files"}}
|
||||||
|
|
||||||
["/upload"
|
["/upload"
|
||||||
{:post {:summary "upload a file"
|
{:post {:summary "upload a file"
|
||||||
|
|
@ -53,7 +61,7 @@
|
||||||
{:get {:summary "downloads a file"
|
{:get {:summary "downloads a file"
|
||||||
:swagger {:produces ["image/png"]}
|
:swagger {:produces ["image/png"]}
|
||||||
:responses {200 {:description "an image"
|
:responses {200 {:description "an image"
|
||||||
:content {"image/png" any?}}}
|
:content {"image/png" {:schema string?}}}}
|
||||||
:handler (fn [_]
|
:handler (fn [_]
|
||||||
{:status 200
|
{:status 200
|
||||||
:headers {"Content-Type" "image/png"}
|
:headers {"Content-Type" "image/png"}
|
||||||
|
|
@ -62,7 +70,7 @@
|
||||||
(io/input-stream))})}}]]
|
(io/input-stream))})}}]]
|
||||||
|
|
||||||
["/math"
|
["/math"
|
||||||
{:tags ["math"]}
|
{:tags #{"math"}}
|
||||||
|
|
||||||
["/plus"
|
["/plus"
|
||||||
{:get {:summary "plus with malli query parameters"
|
{:get {:summary "plus with malli query parameters"
|
||||||
|
|
@ -88,10 +96,26 @@
|
||||||
:responses {200 {:body [:map [:total int?]]}}
|
:responses {200 {:body [:map [:total int?]]}}
|
||||||
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
||||||
{:status 200
|
{:status 200
|
||||||
:body {:total (+ x y)}})}}]]]
|
:body {:total (+ x y)}})}}]]
|
||||||
|
|
||||||
|
["/secure"
|
||||||
|
{:tags #{"secure"}
|
||||||
|
:openapi {:security [{"auth" []}]}
|
||||||
|
:swagger {:security [{"auth" []}]}}
|
||||||
|
["/get"
|
||||||
|
{:get {:summary "endpoint authenticated with a header"
|
||||||
|
:responses {200 {:body [:map [:secret :string]]}
|
||||||
|
401 {:body [:map [:error :string]]}}
|
||||||
|
:handler (fn [request]
|
||||||
|
;; In a real app authentication would be handled by middleware
|
||||||
|
(if (= "secret" (get-in request [:headers "example-api-key"]))
|
||||||
|
{:status 200
|
||||||
|
:body {:secret "I am a marmot"}}
|
||||||
|
{:status 401
|
||||||
|
:body {:error "unauthorized"}}))}}]]]
|
||||||
|
|
||||||
{;;:reitit.middleware/transform dev/print-request-diffs ;; pretty diffs
|
{;;:reitit.middleware/transform dev/print-request-diffs ;; pretty diffs
|
||||||
;;:validate spec/validate ;; enable spec validation for route data
|
:validate spec/validate ;; enable spec validation for route data
|
||||||
;;:reitit.spec/wrap spell/closed ;; strict top-level validation
|
;;:reitit.spec/wrap spell/closed ;; strict top-level validation
|
||||||
:exception pretty/exception
|
:exception pretty/exception
|
||||||
:data {:coercion (reitit.coercion.malli/create
|
:data {:coercion (reitit.coercion.malli/create
|
||||||
|
|
@ -99,7 +123,7 @@
|
||||||
:error-keys #{#_:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
:error-keys #{#_:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
||||||
;; schema identity function (default: close all map schemas)
|
;; schema identity function (default: close all map schemas)
|
||||||
:compile mu/closed-schema
|
:compile mu/closed-schema
|
||||||
;; strip-extra-keys (effects only predefined transformers)
|
;; strip-extra-keys (affects only predefined transformers)
|
||||||
:strip-extra-keys true
|
:strip-extra-keys true
|
||||||
;; add/set default values
|
;; add/set default values
|
||||||
:default-values true
|
:default-values true
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 228 KiB After Width: | Height: | Size: 92 KiB |
|
|
@ -1,4 +1,4 @@
|
||||||
# reitit-ring, clojure.spec, swagger
|
# reitit-ring, clojure.spec, swagger, openapi 3
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
@ -7,6 +7,10 @@
|
||||||
(start)
|
(start)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- Swagger spec served at <http://localhost:3000/swagger.json>
|
||||||
|
- Openapi spec served at <http://localhost:3000/openapi.json>
|
||||||
|
- Swagger UI served at <http://localhost:3000/>
|
||||||
|
|
||||||
To test the endpoints using [httpie](https://httpie.org/):
|
To test the endpoints using [httpie](https://httpie.org/):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||||
:description "Reitit Ring App with Swagger"
|
:description "Reitit Ring App with Swagger"
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
[ring/ring-jetty-adapter "1.12.1"]
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
[metosin/reitit "0.10.0"]
|
||||||
|
[metosin/ring-swagger-ui "5.9.0"]]
|
||||||
:repl-options {:init-ns example.server}
|
:repl-options {:init-ns example.server}
|
||||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.3.2"]]}})
|
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
(ns example.server
|
(ns example.server
|
||||||
(:require [reitit.ring :as ring]
|
(:require [reitit.ring :as ring]
|
||||||
[reitit.coercion.spec]
|
[reitit.coercion.spec]
|
||||||
|
[reitit.openapi :as openapi]
|
||||||
[reitit.swagger :as swagger]
|
[reitit.swagger :as swagger]
|
||||||
[reitit.swagger-ui :as swagger-ui]
|
[reitit.swagger-ui :as swagger-ui]
|
||||||
[reitit.ring.coercion :as coercion]
|
[reitit.ring.coercion :as coercion]
|
||||||
|
|
@ -44,9 +45,15 @@
|
||||||
{:get {:no-doc true
|
{:get {:no-doc true
|
||||||
:swagger {:info {:title "my-api"}}
|
:swagger {:info {:title "my-api"}}
|
||||||
:handler (swagger/create-swagger-handler)}}]
|
:handler (swagger/create-swagger-handler)}}]
|
||||||
|
["/openapi.json"
|
||||||
|
{:get {:no-doc true
|
||||||
|
:openapi {:info {:title "my-api"
|
||||||
|
:description "openapi3-docs with reitit-http"
|
||||||
|
:version "0.0.1"}}
|
||||||
|
:handler (openapi/create-openapi-handler)}}]
|
||||||
|
|
||||||
["/files"
|
["/files"
|
||||||
{:swagger {:tags ["files"]}}
|
{:tags ["files"]}
|
||||||
|
|
||||||
["/upload"
|
["/upload"
|
||||||
{:post {:summary "upload a file"
|
{:post {:summary "upload a file"
|
||||||
|
|
@ -60,6 +67,8 @@
|
||||||
["/download"
|
["/download"
|
||||||
{:get {:summary "downloads a file"
|
{:get {:summary "downloads a file"
|
||||||
:swagger {:produces ["image/png"]}
|
:swagger {:produces ["image/png"]}
|
||||||
|
:responses {200 {:description "an image"
|
||||||
|
:content {"image/png" {:schema string?}}}}
|
||||||
:handler (fn [_]
|
:handler (fn [_]
|
||||||
{:status 200
|
{:status 200
|
||||||
:headers {"Content-Type" "image/png"}
|
:headers {"Content-Type" "image/png"}
|
||||||
|
|
@ -67,7 +76,7 @@
|
||||||
(io/resource "reitit.png"))})}}]]
|
(io/resource "reitit.png"))})}}]]
|
||||||
|
|
||||||
["/math"
|
["/math"
|
||||||
{:swagger {:tags ["math"]}}
|
{:tags ["math"]}
|
||||||
|
|
||||||
["/plus"
|
["/plus"
|
||||||
{:get {:summary "plus with spec query parameters"
|
{:get {:summary "plus with spec query parameters"
|
||||||
|
|
@ -111,6 +120,9 @@
|
||||||
(swagger-ui/create-swagger-ui-handler
|
(swagger-ui/create-swagger-ui-handler
|
||||||
{:path "/"
|
{:path "/"
|
||||||
:config {:validatorUrl nil
|
:config {:validatorUrl nil
|
||||||
|
:urls [{:name "swagger" :url "swagger.json"}
|
||||||
|
{:name "openapi" :url "openapi.json"}]
|
||||||
|
:urls.primaryName "openapi"
|
||||||
:operationsSorter "alpha"}})
|
:operationsSorter "alpha"}})
|
||||||
(ring/create-default-handler))))
|
(ring/create-default-handler))))
|
||||||
|
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 228 KiB After Width: | Height: | Size: 94 KiB |
11
examples/ring-swagger/.gitignore
vendored
|
|
@ -1,11 +0,0 @@
|
||||||
/target
|
|
||||||
/classes
|
|
||||||
/checkouts
|
|
||||||
pom.xml
|
|
||||||
pom.xml.asc
|
|
||||||
*.jar
|
|
||||||
*.class
|
|
||||||
/.lein-*
|
|
||||||
/.nrepl-port
|
|
||||||
.hgignore
|
|
||||||
.hg/
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
# Ring with Swagger example
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```clj
|
|
||||||
> lein repl
|
|
||||||
(start)
|
|
||||||
```
|
|
||||||
|
|
||||||
To test the endpoints using [httpie](https://httpie.org/):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
http GET :3000/math/plus x==1 y==20
|
|
||||||
http POST :3000/math/spec/plus x:=1 y:=20
|
|
||||||
|
|
||||||
http GET :3000/swagger.json
|
|
||||||
```
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/metosin/reitit/master/examples/ring-swagger/swagger.png" />
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Copyright © 2017-2018 Metosin Oy
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
|
||||||
:description "Reitit Ring App with Swagger"
|
|
||||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
|
||||||
[ring/ring-jetty-adapter "1.7.1"]
|
|
||||||
[metosin/reitit "0.7.0-alpha1"]]
|
|
||||||
:repl-options {:init-ns example.server})
|
|
||||||
|
Before Width: | Height: | Size: 494 KiB |
|
|
@ -1,105 +0,0 @@
|
||||||
(ns example.server
|
|
||||||
(:require [reitit.ring :as ring]
|
|
||||||
[reitit.coercion.spec]
|
|
||||||
[reitit.swagger :as swagger]
|
|
||||||
[reitit.swagger-ui :as swagger-ui]
|
|
||||||
[reitit.ring.coercion :as coercion]
|
|
||||||
[reitit.dev.pretty :as pretty]
|
|
||||||
[reitit.ring.middleware.muuntaja :as muuntaja]
|
|
||||||
[reitit.ring.middleware.exception :as exception]
|
|
||||||
[reitit.ring.middleware.multipart :as multipart]
|
|
||||||
[reitit.ring.middleware.parameters :as parameters]
|
|
||||||
;; Uncomment to use
|
|
||||||
; [reitit.ring.middleware.dev :as dev]
|
|
||||||
[ring.adapter.jetty :as jetty]
|
|
||||||
[muuntaja.core :as m]
|
|
||||||
[clojure.java.io :as io]))
|
|
||||||
|
|
||||||
(def app
|
|
||||||
(ring/ring-handler
|
|
||||||
(ring/router
|
|
||||||
[["/swagger.json"
|
|
||||||
{:get {:no-doc true
|
|
||||||
:swagger {:info {:title "my-api"
|
|
||||||
:description "with reitit-ring"}}
|
|
||||||
:handler (swagger/create-swagger-handler)}}]
|
|
||||||
|
|
||||||
["/files"
|
|
||||||
{:swagger {:tags ["files"]}}
|
|
||||||
|
|
||||||
["/upload"
|
|
||||||
{:post {:summary "upload a file"
|
|
||||||
:parameters {:multipart {:file multipart/temp-file-part}}
|
|
||||||
:responses {200 {:body {:name string?, :size int?}}}
|
|
||||||
:handler (fn [{{{:keys [file]} :multipart} :parameters}]
|
|
||||||
{:status 200
|
|
||||||
:body {:name (:filename file)
|
|
||||||
:size (:size file)}})}}]
|
|
||||||
|
|
||||||
["/download"
|
|
||||||
{:get {:summary "downloads a file"
|
|
||||||
:swagger {:produces ["image/png"]}
|
|
||||||
:handler (fn [_]
|
|
||||||
{:status 200
|
|
||||||
:headers {"Content-Type" "image/png"}
|
|
||||||
:body (-> "reitit.png"
|
|
||||||
(io/resource)
|
|
||||||
(io/input-stream))})}}]]
|
|
||||||
|
|
||||||
["/math"
|
|
||||||
{:swagger {:tags ["math"]}}
|
|
||||||
|
|
||||||
["/plus"
|
|
||||||
{:get {:summary "plus with spec query parameters"
|
|
||||||
:parameters {:query {:x int?
|
|
||||||
:y int?}}
|
|
||||||
:responses {200 {:body {:total int?}}}
|
|
||||||
:handler (fn [{{{:keys [x y]} :query} :parameters}]
|
|
||||||
{:status 200
|
|
||||||
:body {:total (+ x y)}})}
|
|
||||||
:post {:summary "plus with spec body parameters"
|
|
||||||
:parameters {:body {:x int?
|
|
||||||
:y int?}}
|
|
||||||
:responses {200 {:body {:total int?}}}
|
|
||||||
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
|
||||||
{:status 200
|
|
||||||
:body {:total (+ x y)}})}}]]]
|
|
||||||
|
|
||||||
{;;:reitit.middleware/transform dev/print-request-diffs ;; pretty diffs
|
|
||||||
;;:validate spec/validate ;; enable spec validation for route data
|
|
||||||
;;:reitit.spec/wrap spell/closed ;; strict top-level validation
|
|
||||||
:exception pretty/exception
|
|
||||||
:data {:coercion reitit.coercion.spec/coercion
|
|
||||||
:muuntaja m/instance
|
|
||||||
:middleware [;; swagger feature
|
|
||||||
swagger/swagger-feature
|
|
||||||
;; query-params & form-params
|
|
||||||
parameters/parameters-middleware
|
|
||||||
;; content-negotiation
|
|
||||||
muuntaja/format-negotiate-middleware
|
|
||||||
;; encoding response body
|
|
||||||
muuntaja/format-response-middleware
|
|
||||||
;; exception handling
|
|
||||||
(exception/create-exception-middleware
|
|
||||||
{::exception/default (partial exception/wrap-log-to-console exception/default-handler)})
|
|
||||||
;; decoding request body
|
|
||||||
muuntaja/format-request-middleware
|
|
||||||
;; coercing response bodys
|
|
||||||
coercion/coerce-response-middleware
|
|
||||||
;; coercing request parameters
|
|
||||||
coercion/coerce-request-middleware
|
|
||||||
;; multipart
|
|
||||||
multipart/multipart-middleware]}})
|
|
||||||
(ring/routes
|
|
||||||
(swagger-ui/create-swagger-ui-handler
|
|
||||||
{:path "/"
|
|
||||||
:config {:validatorUrl nil
|
|
||||||
:operationsSorter "alpha"}})
|
|
||||||
(ring/create-default-handler))))
|
|
||||||
|
|
||||||
(defn start []
|
|
||||||
(jetty/run-jetty #'app {:port 3000, :join? false})
|
|
||||||
(println "server running in port 3000"))
|
|
||||||
|
|
||||||
(comment
|
|
||||||
(start))
|
|
||||||
|
Before Width: | Height: | Size: 228 KiB |
18
karma.conf.js
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
module.exports = function (config) {
|
||||||
|
config.set({
|
||||||
|
browsers: ['ChromeHeadless'],
|
||||||
|
// The directory where the output file lives
|
||||||
|
basePath: 'target/karma',
|
||||||
|
// The file itself
|
||||||
|
files: ['ci.js'],
|
||||||
|
frameworks: ['cljs-test'],
|
||||||
|
reporters: ['progress'],
|
||||||
|
plugins: ['karma-cljs-test', 'karma-chrome-launcher'],
|
||||||
|
colors: true,
|
||||||
|
logLevel: config.LOG_INFO,
|
||||||
|
client: {
|
||||||
|
args: ["shadow.test.karma.init"],
|
||||||
|
singleRun: true
|
||||||
|
},
|
||||||
|
})
|
||||||
|
};
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
(defproject metosin/reitit-core "0.7.0-alpha1"
|
(defproject metosin/reitit-core "0.10.0"
|
||||||
:description "Snappy data-driven router for Clojure(Script)"
|
:description "Snappy data-driven router for Clojure(Script)"
|
||||||
:url "https://github.com/metosin/reitit"
|
:url "https://github.com/metosin/reitit"
|
||||||
:license {:name "Eclipse Public License"
|
:license {:name "Eclipse Public License"
|
||||||
|
|
@ -10,4 +10,5 @@
|
||||||
:parent-project {:path "../../project.clj"
|
:parent-project {:path "../../project.clj"
|
||||||
:inherit [:deploy-repositories :managed-dependencies]}
|
:inherit [:deploy-repositories :managed-dependencies]}
|
||||||
:java-source-paths ["java-src"]
|
:java-source-paths ["java-src"]
|
||||||
|
:javac-options ["-Xlint:unchecked" "-target" "11" "-source" "11"]
|
||||||
:dependencies [[meta-merge]])
|
:dependencies [[meta-merge]])
|
||||||
|
|
|
||||||
|
|
@ -1,189 +0,0 @@
|
||||||
(ns ctrl.merge
|
|
||||||
(:refer-clojure :exclude [merge])
|
|
||||||
(:require [clojure.core :as c]
|
|
||||||
[clojure.set :as set]))
|
|
||||||
|
|
||||||
(defn- meta* [obj]
|
|
||||||
(if #?(:clj (instance? clojure.lang.IObj obj)
|
|
||||||
:cljs (satisfies? IMeta obj))
|
|
||||||
(meta obj)))
|
|
||||||
|
|
||||||
(defn- with-meta* [obj m]
|
|
||||||
(if #?(:clj (instance? clojure.lang.IObj obj)
|
|
||||||
:cljs (satisfies? IWithMeta obj))
|
|
||||||
(with-meta obj m)
|
|
||||||
obj))
|
|
||||||
|
|
||||||
(defn- displace? [obj]
|
|
||||||
(-> obj meta* :displace))
|
|
||||||
|
|
||||||
(defn- replace? [obj]
|
|
||||||
(-> obj meta* :replace))
|
|
||||||
|
|
||||||
(defn- top-displace? [obj]
|
|
||||||
(-> obj meta* :top-displace))
|
|
||||||
|
|
||||||
(defn- different-priority? [left right]
|
|
||||||
(boolean (or (some (some-fn nil? displace? replace?) [left right])
|
|
||||||
(top-displace? left))))
|
|
||||||
|
|
||||||
(defn- remove-top-displace [obj {:keys [::replace-nil]}]
|
|
||||||
(cond replace-nil nil
|
|
||||||
(top-displace? obj) obj
|
|
||||||
:else (vary-meta obj dissoc :top-displace)))
|
|
||||||
|
|
||||||
(defn- pick-prioritized [left right options]
|
|
||||||
(cond (nil? left) right
|
|
||||||
(nil? right) (remove-top-displace left options)
|
|
||||||
|
|
||||||
(top-displace? left) right
|
|
||||||
|
|
||||||
(and (displace? left) ;; Pick the rightmost
|
|
||||||
(displace? right)) ;; if both are marked as displaceable
|
|
||||||
(with-meta* right
|
|
||||||
(c/merge (meta* left) (meta* right)))
|
|
||||||
|
|
||||||
(and (replace? left) ;; Pick the rightmost
|
|
||||||
(replace? right)) ;; if both are marked as replaceable
|
|
||||||
(with-meta* right
|
|
||||||
(c/merge (meta* left) (meta* right)))
|
|
||||||
|
|
||||||
(or (displace? left)
|
|
||||||
(replace? right))
|
|
||||||
(with-meta* right
|
|
||||||
(c/merge (-> left meta* (dissoc :displace))
|
|
||||||
(-> right meta* (dissoc :replace))))
|
|
||||||
|
|
||||||
(or (replace? left)
|
|
||||||
(displace? right))
|
|
||||||
(with-meta* left
|
|
||||||
(c/merge (-> right meta* (dissoc :displace))
|
|
||||||
(-> left meta* (dissoc :replace))))))
|
|
||||||
|
|
||||||
(defn find-custom-merge [path path-map]
|
|
||||||
(letfn [(match [x f] (cond (keyword? f) (= x f) (or (fn? f) (ifn? f)) (f x)))]
|
|
||||||
(reduce (fn [_ [ps f]] (let [match (loop [[p & pr] path, [pp & ppr] ps]
|
|
||||||
(cond (and p pp (match p pp)) (recur pr ppr)
|
|
||||||
(= nil p pp) true))]
|
|
||||||
(when match (reduced f)))) nil path-map)))
|
|
||||||
|
|
||||||
;;
|
|
||||||
;; public api
|
|
||||||
;;
|
|
||||||
|
|
||||||
(defn any [_] true)
|
|
||||||
|
|
||||||
(defn merge
|
|
||||||
([] {})
|
|
||||||
([left] left)
|
|
||||||
([left right] (merge left right nil))
|
|
||||||
([left right {:keys [::path ::path-map] :as options}]
|
|
||||||
(let [custom-merge (find-custom-merge path path-map)]
|
|
||||||
(cond
|
|
||||||
(different-priority? left right)
|
|
||||||
(pick-prioritized left right options)
|
|
||||||
|
|
||||||
custom-merge
|
|
||||||
(custom-merge left right options)
|
|
||||||
|
|
||||||
(and (map? left) (map? right))
|
|
||||||
(let [merge-entry (fn [m e]
|
|
||||||
(let [k (key e) v (val e)]
|
|
||||||
(if (contains? m k)
|
|
||||||
(assoc m k (merge (get m k) v (update options ::path (fnil conj []) k)))
|
|
||||||
(assoc m k v))))
|
|
||||||
merge2 (fn [m1 m2]
|
|
||||||
(reduce merge-entry (or m1 {}) (seq m2)))]
|
|
||||||
(reduce merge2 [left right]))
|
|
||||||
|
|
||||||
(and (set? left) (set? right))
|
|
||||||
(set/union right left)
|
|
||||||
|
|
||||||
(and (coll? left) (coll? right))
|
|
||||||
(if (or (-> left meta :prepend)
|
|
||||||
(-> right meta :prepend))
|
|
||||||
(-> (into (empty left) (concat right left))
|
|
||||||
(with-meta (c/merge (meta left)
|
|
||||||
(select-keys (meta right) [:displace]))))
|
|
||||||
(into (empty left) (concat left right)))
|
|
||||||
|
|
||||||
:else right))))
|
|
||||||
|
|
||||||
;;
|
|
||||||
;; spike
|
|
||||||
;;
|
|
||||||
|
|
||||||
(comment
|
|
||||||
(merge
|
|
||||||
{:parameters {:query {:x 1}}}
|
|
||||||
{:parameters {:query nil}}
|
|
||||||
{::replace-nil true}))
|
|
||||||
|
|
||||||
(ns demo2)
|
|
||||||
|
|
||||||
(require '[reitit.ring :as ring]
|
|
||||||
'[malli.util :as mu]
|
|
||||||
'[reitit.core :as r]
|
|
||||||
'[ctrl.merge :as cm])
|
|
||||||
|
|
||||||
(defn ring-path-map [f]
|
|
||||||
[[[:parameters cm/any] f]
|
|
||||||
[[ring/http-methods :parameters cm/any] f]
|
|
||||||
[[:responses cm/any :body] f]
|
|
||||||
[[ring/http-methods :responses cm/any :body] f]])
|
|
||||||
|
|
||||||
(defn malli-merge [x y _] (mu/merge x y))
|
|
||||||
|
|
||||||
(-> (ring/router
|
|
||||||
["/api" {:parameters {:header [:map ["Api" :string]]}}
|
|
||||||
["/math/:x" {:parameters {:path [:map [:x :int]]
|
|
||||||
:query [:map [:b :string]]
|
|
||||||
:header [:map ["Math" :string]]}
|
|
||||||
:responses {200 {:body [:map [:total :int]]}
|
|
||||||
500 {:description "fail"}}}
|
|
||||||
["/plus/:y" {:get {:parameters {:query ^:replace [:map [:a :int]]
|
|
||||||
:body [:map [:b :int]]
|
|
||||||
:header [:map ["Plus" :string]]
|
|
||||||
:path [:map [:y :int]]}
|
|
||||||
:responses {200 {:body [:map [:total2 :int]]}
|
|
||||||
500 {:description "fail"}}
|
|
||||||
:handler (constantly {:status 200, :body "ok"})}}]]]
|
|
||||||
{:meta-merge #(cm/merge %1 %2 {::cm/path-map (ring-path-map malli-merge)})})
|
|
||||||
(ring/ring-handler)
|
|
||||||
(ring/get-router)
|
|
||||||
(r/compiled-routes)
|
|
||||||
(last)
|
|
||||||
(last)
|
|
||||||
:get
|
|
||||||
:data)
|
|
||||||
;{:parameters {:header [:map
|
|
||||||
; ["Api" :string]
|
|
||||||
; ["Math" :string]
|
|
||||||
; ["Plus" :string]],
|
|
||||||
; :path [:map
|
|
||||||
; [:x :int]
|
|
||||||
; [:y :int]],
|
|
||||||
; :query [:map [:a :int]],
|
|
||||||
; :body [:map [:b :int]]},
|
|
||||||
; :responses {200 {:body [:map
|
|
||||||
; [:total :int]
|
|
||||||
; [:total2 :int]]}
|
|
||||||
; 500 {:description "fail"}},
|
|
||||||
; :handler #object[clojure.core$constantly$fn__5740]}
|
|
||||||
|
|
||||||
(cm/merge
|
|
||||||
{:parameters {:query [:map [:x :int]]}
|
|
||||||
:get {:parameters {:query [:map [:x :int]]}
|
|
||||||
:responses {200 {:body [:map [:total :int]]}}}}
|
|
||||||
{:parameters {:query [:map [:y :int]]}
|
|
||||||
:get {:parameters {:query [:map [:y :int]]}
|
|
||||||
:responses {200 {:body [:map [:total :int]]}}}
|
|
||||||
:post {:parameters {:query [:map [:y :int]]}}}
|
|
||||||
{::cm/path-map [[[:parameters cm/any] malli-merge]
|
|
||||||
[[cm/any :parameters cm/any] malli-merge]
|
|
||||||
[[:responses cm/any :body] malli-merge]
|
|
||||||
[[cm/any :responses cm/any :body] malli-merge]]})
|
|
||||||
;{:parameters {:query [:map [:x :int] [:y :int]]},
|
|
||||||
; :get {:parameters {:query [:map [:x :int] [:y :int]]}
|
|
||||||
; :responses {200 {:body [:map [:total :int]]}}},
|
|
||||||
; :post {:parameters {:query [:map [:y :int]]}}}
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
(ns reitit.coercion
|
(ns reitit.coercion
|
||||||
(:require [clojure.walk :as walk]
|
(:require [#?(:clj reitit.walk :cljs clojure.walk) :as walk]
|
||||||
|
[reitit.core :as r]
|
||||||
[reitit.impl :as impl])
|
[reitit.impl :as impl])
|
||||||
#?(:clj
|
#?(:clj
|
||||||
(:import (java.io Writer))))
|
(:import (java.io Writer))))
|
||||||
|
|
@ -13,11 +14,14 @@
|
||||||
(-get-name [this] "Keyword name for the coercion")
|
(-get-name [this] "Keyword name for the coercion")
|
||||||
(-get-options [this] "Coercion options")
|
(-get-options [this] "Coercion options")
|
||||||
(-get-apidocs [this specification data] "Returns api documentation")
|
(-get-apidocs [this specification data] "Returns api documentation")
|
||||||
|
;; TODO doc options:
|
||||||
|
(-get-model-apidocs [this specification model options] "Convert model into a format that can be used in api docs")
|
||||||
(-compile-model [this model name] "Compiles a model")
|
(-compile-model [this model name] "Compiles a model")
|
||||||
(-open-model [this model] "Returns a new model which allows extra keys in maps")
|
(-open-model [this model] "Returns a new model which allows extra keys in maps")
|
||||||
(-encode-error [this error] "Converts error in to a serializable format")
|
(-encode-error [this error] "Converts error in to a serializable format")
|
||||||
(-request-coercer [this type model] "Returns a `value format => value` request coercion function")
|
(-request-coercer [this type model] "Returns a `value format => value` request coercion function")
|
||||||
(-response-coercer [this model] "Returns a `value format => value` response coercion function"))
|
(-response-coercer [this model] "Returns a `value format => value` response coercion function")
|
||||||
|
(-query-string-coercer [this model] "Returns a `value => value` query string coercion function"))
|
||||||
|
|
||||||
#?(:clj
|
#?(:clj
|
||||||
(defmethod print-method ::coercion [coercion ^Writer w]
|
(defmethod print-method ::coercion [coercion ^Writer w]
|
||||||
|
|
@ -37,7 +41,6 @@
|
||||||
(def ^:no-doc default-parameter-coercion
|
(def ^:no-doc default-parameter-coercion
|
||||||
{:query (->ParameterCoercion :query-params :string true true)
|
{:query (->ParameterCoercion :query-params :string true true)
|
||||||
:body (->ParameterCoercion :body-params :body false false)
|
:body (->ParameterCoercion :body-params :body false false)
|
||||||
:request (->ParameterCoercion :body-params :request false false)
|
|
||||||
:form (->ParameterCoercion :form-params :string true true)
|
:form (->ParameterCoercion :form-params :string true true)
|
||||||
:header (->ParameterCoercion :headers :string true true)
|
:header (->ParameterCoercion :headers :string true true)
|
||||||
:path (->ParameterCoercion :path-params :string true true)
|
:path (->ParameterCoercion :path-params :string true true)
|
||||||
|
|
@ -83,54 +86,48 @@
|
||||||
value)
|
value)
|
||||||
|
|
||||||
;; TODO: support faster key walking, walk/keywordize-keys is quite slow...
|
;; TODO: support faster key walking, walk/keywordize-keys is quite slow...
|
||||||
(defn request-coercer [coercion type model {::keys [extract-request-format parameter-coercion serialize-failed-result]
|
(defn request-coercer [coercion type model {::keys [extract-request-format parameter-coercion serialize-failed-result skip]
|
||||||
:or {extract-request-format extract-request-format-default
|
:or {extract-request-format extract-request-format-default
|
||||||
parameter-coercion default-parameter-coercion}}]
|
parameter-coercion default-parameter-coercion
|
||||||
|
skip #{}}}]
|
||||||
(if coercion
|
(if coercion
|
||||||
(if-let [{:keys [keywordize? open? in style]} (parameter-coercion type)]
|
(when-let [{:keys [keywordize? open? in style]} (parameter-coercion type)]
|
||||||
(let [transform (comp (if keywordize? walk/keywordize-keys identity) in)
|
(when-not (skip style)
|
||||||
->open (if open? #(-open-model coercion %) identity)
|
(let [transform (comp (if keywordize? walk/keywordize-keys identity) in)
|
||||||
format-schema-pairs (if (= :request style)
|
->open (if open? #(-open-model coercion %) identity)
|
||||||
(conj (:content model) [:default (:body model)])
|
coercer (-request-coercer coercion style (->open model))]
|
||||||
[[:default model]])
|
(when coercer
|
||||||
format->coercer (some->> (for [[format schema] format-schema-pairs
|
(fn [request]
|
||||||
:when schema]
|
(let [value (transform request)
|
||||||
[format (-request-coercer coercion (case style :request :body style) (->open schema))])
|
format (extract-request-format request)
|
||||||
(filter second)
|
result (coercer value format)]
|
||||||
(seq)
|
(if (error? result)
|
||||||
(into {}))]
|
(request-coercion-failed! result coercion value in request serialize-failed-result)
|
||||||
(when format->coercer
|
result)))))))))
|
||||||
(fn [request]
|
|
||||||
(let [value (transform request)
|
|
||||||
format (extract-request-format request)
|
|
||||||
coercer (or (format->coercer format)
|
|
||||||
(format->coercer :default)
|
|
||||||
-identity-coercer)
|
|
||||||
result (coercer value format)]
|
|
||||||
(if (error? result)
|
|
||||||
(request-coercion-failed! result coercion value in request serialize-failed-result)
|
|
||||||
result))))))))
|
|
||||||
|
|
||||||
(defn extract-response-format-default [request _]
|
(defn get-default [request-or-response]
|
||||||
(-> request :muuntaja/response :format))
|
(or (-> request-or-response :content :default)
|
||||||
|
(some->> request-or-response :body (assoc {} :schema))))
|
||||||
|
|
||||||
(defn response-coercer [coercion {:keys [content body]} {:keys [extract-response-format serialize-failed-result]
|
(defn content-request-coercer [coercion {:keys [content body]} {::keys [extract-request-format serialize-failed-result]
|
||||||
:or {extract-response-format extract-response-format-default}}]
|
:or {extract-request-format extract-request-format-default}}]
|
||||||
(if coercion
|
(when coercion
|
||||||
(let [per-format-coercers (some->> (for [[format schema] content]
|
(let [in :body-params
|
||||||
[format (-response-coercer coercion schema)])
|
format->coercer (some->> (concat (when body
|
||||||
(filter second)
|
[[:default (-request-coercer coercion :body body)]])
|
||||||
(seq)
|
(for [[format {:keys [schema]}] content, :when schema]
|
||||||
(into {}))
|
[format (-request-coercer coercion :body schema)]))
|
||||||
default (when body (-response-coercer coercion body))]
|
(filter second) (seq) (into (array-map)))]
|
||||||
(when (or per-format-coercers default)
|
(when format->coercer
|
||||||
(fn [request response]
|
(fn [request]
|
||||||
(let [format (extract-response-format request response)
|
(let [value (in request)
|
||||||
value (:body response)
|
format (extract-request-format request)
|
||||||
coercer (get per-format-coercers format (or default -identity-coercer))
|
coercer (or (format->coercer format)
|
||||||
|
(format->coercer :default)
|
||||||
|
-identity-coercer)
|
||||||
result (coercer value format)]
|
result (coercer value format)]
|
||||||
(if (error? result)
|
(if (error? result)
|
||||||
(response-coercion-failed! result coercion value request response serialize-failed-result)
|
(request-coercion-failed! result coercion value in request serialize-failed-result)
|
||||||
result)))))))
|
result)))))))
|
||||||
|
|
||||||
(defn encode-error [data]
|
(defn encode-error [data]
|
||||||
|
|
@ -145,58 +142,58 @@
|
||||||
(impl/fast-assoc acc k (coercer request)))
|
(impl/fast-assoc acc k (coercer request)))
|
||||||
{} coercers))
|
{} coercers))
|
||||||
|
|
||||||
(defn coerce-response [coercers request response]
|
(defn request-coercers
|
||||||
(if response
|
([coercion parameters opts]
|
||||||
(if-let [coercer (or (coercers (:status response)) (coercers :default))]
|
(some->> (for [[k v] parameters, :when v]
|
||||||
(impl/fast-assoc response :body (coercer request response))
|
[k (request-coercer coercion k v opts)])
|
||||||
response)))
|
(filter second) (seq) (into {})))
|
||||||
|
([coercion parameters route-request opts]
|
||||||
|
(let [crc (when route-request (some->> (content-request-coercer coercion route-request opts) (array-map :request)))
|
||||||
|
rcs (request-coercers coercion parameters (cond-> opts route-request (assoc ::skip #{:body})))]
|
||||||
|
(if (and crc rcs) (into crc (vec rcs)) (or crc rcs)))))
|
||||||
|
|
||||||
(defn request-coercers [coercion parameters opts]
|
(defn extract-response-format-default [request response]
|
||||||
(some->> (for [[k v] parameters
|
(or (get-in response [:headers "Content-Type"])
|
||||||
:when v]
|
(:muuntaja/content-type response)
|
||||||
[k (request-coercer coercion k v opts)])
|
(-> request :muuntaja/response :format)))
|
||||||
(filter second)
|
|
||||||
(seq)
|
|
||||||
(into {})))
|
|
||||||
|
|
||||||
(defn response-coercers [coercion responses opts]
|
(defn -format->coercer [coercion {:keys [content body]} _opts]
|
||||||
(some->> (for [[status model] responses]
|
(->> (concat (when body
|
||||||
[status (response-coercer coercion model opts)])
|
[[:default (-response-coercer coercion body)]])
|
||||||
(filter second)
|
(for [[format {:keys [schema]}] content, :when schema]
|
||||||
(seq)
|
[format (-response-coercer coercion schema)]))
|
||||||
(into {})))
|
(filter second) (into (array-map))))
|
||||||
|
|
||||||
;;
|
(defn response-coercer [coercion responses {:keys [extract-response-format serialize-failed-result]
|
||||||
;; api-docs
|
:or {extract-response-format extract-response-format-default}
|
||||||
;;
|
:as opts}]
|
||||||
|
(when coercion
|
||||||
(defn -warn-unsupported-coercions [{:keys [parameters responses] :as data}]
|
(let [status->format->coercer
|
||||||
(when (:request parameters)
|
(into {}
|
||||||
(println "WARNING [reitit.coercion]: swagger apidocs don't support :request coercion"))
|
(for [[status model] responses]
|
||||||
(when (some :content (vals responses))
|
(do
|
||||||
(println "WARNING [reitit.coercion]: swagger apidocs don't support :responses :content coercion")))
|
(when-not (or (= :default status) (int? status))
|
||||||
|
(throw (ex-info "Response status must be int or :default" {:status status})))
|
||||||
(defn get-apidocs [coercion specification data]
|
[status (-format->coercer coercion model opts)])))]
|
||||||
(let [swagger-parameter {:query :query
|
(when-not (every? empty? (vals status->format->coercer)) ;; fast path: return nil if there are no models to coerce
|
||||||
:body :body
|
(fn [request response]
|
||||||
:form :formData
|
(let [format->coercer (or (status->format->coercer (:status response))
|
||||||
:header :header
|
(status->format->coercer :default))
|
||||||
:path :path
|
format (extract-response-format request response)
|
||||||
:multipart :formData}]
|
coercer (when format->coercer
|
||||||
(case specification
|
(or (format->coercer format)
|
||||||
:openapi (-get-apidocs coercion specification data)
|
(format->coercer :default)))]
|
||||||
:swagger (do
|
(if-not coercer
|
||||||
(-warn-unsupported-coercions data)
|
response
|
||||||
(->> (update
|
(let [value (:body response)
|
||||||
data
|
coerced (coercer (:body response) format)
|
||||||
:parameters
|
result (if (error? coerced)
|
||||||
(fn [parameters]
|
(response-coercion-failed! coerced coercion value request response serialize-failed-result)
|
||||||
(->> parameters
|
coerced)]
|
||||||
(map (fn [[k v]] [(swagger-parameter k) v]))
|
(impl/fast-assoc response :body result)))))))))
|
||||||
(filter first)
|
|
||||||
(into {}))))
|
|
||||||
(-get-apidocs coercion specification))))))
|
|
||||||
|
|
||||||
|
(defn -compile-parameters [data coercion]
|
||||||
|
(impl/path-update data [[[:parameters any?] #(-compile-model coercion % nil)]]))
|
||||||
|
|
||||||
;;
|
;;
|
||||||
;; integration
|
;; integration
|
||||||
|
|
@ -204,17 +201,59 @@
|
||||||
|
|
||||||
(defn compile-request-coercers
|
(defn compile-request-coercers
|
||||||
"A router :compile implementation which reads the `:parameters`
|
"A router :compile implementation which reads the `:parameters`
|
||||||
and `:coercion` data to create compiled coercers into Match under
|
and `:coercion` data to both compile the schemas and create compiled coercers
|
||||||
`:result. A pre-requisite to use [[coerce!]]."
|
into Match under `:result with the following keys:
|
||||||
[[_ {:keys [parameters coercion]}] opts]
|
|
||||||
|
| key | description
|
||||||
|
| ----------|-------------
|
||||||
|
| `:data` | data with compiled schemas
|
||||||
|
| `:coerce` | function of `Match -> coerced parameters` to coerce parameters
|
||||||
|
|
||||||
|
A pre-requisite to use [[coerce!]].
|
||||||
|
|
||||||
|
NOTE: this is not needed with ring/http, where the coercion compilation is
|
||||||
|
managed in the request coercion middleware/interceptors."
|
||||||
|
[[_ {:keys [parameters coercion] :as data}] opts]
|
||||||
(if (and parameters coercion)
|
(if (and parameters coercion)
|
||||||
(request-coercers coercion parameters opts)))
|
(let [{:keys [parameters] :as data} (-compile-parameters data coercion)]
|
||||||
|
{:data data
|
||||||
|
:coerce (request-coercers coercion parameters opts)})))
|
||||||
|
|
||||||
(defn coerce!
|
(defn coerce!
|
||||||
"Returns a map of coerced input parameters using pre-compiled
|
"Returns a map of coerced input parameters using pre-compiled coercers in `Match`
|
||||||
coercers under `:result` (provided by [[compile-request-coercers]].
|
under path `[:result :coerce]` (provided by [[compile-request-coercers]].
|
||||||
Throws `ex-info` if parameters can't be coerced
|
Throws `ex-info` if parameters can't be coerced. If coercion or parameters
|
||||||
If coercion or parameters are not defined, return `nil`"
|
are not defined, returns `nil`"
|
||||||
[match]
|
[match]
|
||||||
(if-let [coercers (:result match)]
|
(if-let [coercers (-> match :result :coerce)]
|
||||||
(coerce-request coercers match)))
|
(coerce-request coercers match)))
|
||||||
|
|
||||||
|
(defn coerce-query-params
|
||||||
|
"Uses an input schema and coercion implementation from the given match to
|
||||||
|
encode query-parameters map.
|
||||||
|
|
||||||
|
If no match, no input schema or coercion implementation, just returns the
|
||||||
|
original parameters map."
|
||||||
|
[match query-params]
|
||||||
|
(when query-params
|
||||||
|
(let [coercion (-> match :data :coercion)
|
||||||
|
schema (when coercion
|
||||||
|
(-compile-model coercion (-> match :data :parameters :query) nil))
|
||||||
|
coercer (when (and schema coercion)
|
||||||
|
(-query-string-coercer coercion schema))]
|
||||||
|
(if coercer
|
||||||
|
(let [result (coercer query-params :default)]
|
||||||
|
(if (error? result)
|
||||||
|
(throw (ex-info "Query parameters coercion failed"
|
||||||
|
result))
|
||||||
|
result))
|
||||||
|
query-params))))
|
||||||
|
|
||||||
|
(defn match->path
|
||||||
|
"Create routing path from given match and optional query-parameters map.
|
||||||
|
|
||||||
|
Query-parameters are encoded using the input schema and coercion implementation."
|
||||||
|
([match]
|
||||||
|
(r/match->path match))
|
||||||
|
([match query-params]
|
||||||
|
(r/match->path match (coerce-query-params match query-params))))
|
||||||
|
|
|
||||||
|
|
@ -28,6 +28,10 @@
|
||||||
:cljs function)
|
:cljs function)
|
||||||
(expand [this _] {:handler this})
|
(expand [this _] {:handler this})
|
||||||
|
|
||||||
|
#?(:clj clojure.lang.Var
|
||||||
|
:cljs cljs.core.Var)
|
||||||
|
(expand [this _] {:handler this})
|
||||||
|
|
||||||
nil
|
nil
|
||||||
(expand [_ _]))
|
(expand [_ _]))
|
||||||
|
|
||||||
|
|
@ -42,7 +46,7 @@
|
||||||
(options [this])
|
(options [this])
|
||||||
(route-names [this])
|
(route-names [this])
|
||||||
(match-by-path [this path])
|
(match-by-path [this path])
|
||||||
(match-by-name [this name] [this name path-params]))
|
(match-by-name [this name] [this name path-params] [this name path-params opts]))
|
||||||
|
|
||||||
(defn router? [x]
|
(defn router? [x]
|
||||||
(satisfies? Router x))
|
(satisfies? Router x))
|
||||||
|
|
@ -64,10 +68,12 @@
|
||||||
(:template match) (:required match) path-params)))))
|
(:template match) (:required match) path-params)))))
|
||||||
|
|
||||||
(defn match->path
|
(defn match->path
|
||||||
|
"Create routing path from given match and optional query-parameters map."
|
||||||
([match]
|
([match]
|
||||||
(match->path match nil))
|
(match->path match nil))
|
||||||
([match query-params]
|
([match query-params]
|
||||||
(some-> match :path (cond-> (seq query-params) (str "?" (impl/query-string query-params))))))
|
(some-> match :path (cond-> (seq query-params)
|
||||||
|
(str "?" (impl/query-string query-params))))))
|
||||||
|
|
||||||
;;
|
;;
|
||||||
;; Different routers
|
;; Different routers
|
||||||
|
|
@ -116,9 +122,11 @@
|
||||||
(match-by-name [_ name]
|
(match-by-name [_ name]
|
||||||
(if-let [match (impl/fast-get lookup name)]
|
(if-let [match (impl/fast-get lookup name)]
|
||||||
(match nil)))
|
(match nil)))
|
||||||
(match-by-name [_ name path-params]
|
(match-by-name [r name path-params]
|
||||||
|
(match-by-name r name path-params nil))
|
||||||
|
(match-by-name [_ name path-params opts]
|
||||||
(if-let [match (impl/fast-get lookup name)]
|
(if-let [match (impl/fast-get lookup name)]
|
||||||
(match (impl/path-params path-params))))))))
|
(match (impl/path-params path-params opts))))))))
|
||||||
|
|
||||||
(defn lookup-router
|
(defn lookup-router
|
||||||
"Creates a lookup-router from resolved routes and optional
|
"Creates a lookup-router from resolved routes and optional
|
||||||
|
|
@ -155,9 +163,11 @@
|
||||||
(match-by-name [_ name]
|
(match-by-name [_ name]
|
||||||
(if-let [match (impl/fast-get lookup name)]
|
(if-let [match (impl/fast-get lookup name)]
|
||||||
(match nil)))
|
(match nil)))
|
||||||
(match-by-name [_ name path-params]
|
(match-by-name [r name path-params]
|
||||||
|
(match-by-name r name path-params nil))
|
||||||
|
(match-by-name [_ name path-params opts]
|
||||||
(if-let [match (impl/fast-get lookup name)]
|
(if-let [match (impl/fast-get lookup name)]
|
||||||
(match (impl/path-params path-params))))))))
|
(match (impl/path-params path-params opts))))))))
|
||||||
|
|
||||||
(defn trie-router
|
(defn trie-router
|
||||||
"Creates a special prefix-tree router from resolved routes and optional
|
"Creates a special prefix-tree router from resolved routes and optional
|
||||||
|
|
@ -202,9 +212,11 @@
|
||||||
(match-by-name [_ name]
|
(match-by-name [_ name]
|
||||||
(if-let [match (impl/fast-get lookup name)]
|
(if-let [match (impl/fast-get lookup name)]
|
||||||
(match nil)))
|
(match nil)))
|
||||||
(match-by-name [_ name path-params]
|
(match-by-name [r name path-params]
|
||||||
|
(match-by-name r name path-params nil))
|
||||||
|
(match-by-name [_ name path-params opts]
|
||||||
(if-let [match (impl/fast-get lookup name)]
|
(if-let [match (impl/fast-get lookup name)]
|
||||||
(match (impl/path-params path-params))))))))
|
(match (impl/path-params path-params opts))))))))
|
||||||
|
|
||||||
(defn single-static-path-router
|
(defn single-static-path-router
|
||||||
"Creates a fast router of 1 static route(s) and optional
|
"Creates a fast router of 1 static route(s) and optional
|
||||||
|
|
@ -232,8 +244,10 @@
|
||||||
(if (#?(:clj .equals :cljs =) p path) match))
|
(if (#?(:clj .equals :cljs =) p path) match))
|
||||||
(match-by-name [_ name]
|
(match-by-name [_ name]
|
||||||
(if (= n name) match))
|
(if (= n name) match))
|
||||||
(match-by-name [_ name path-params]
|
(match-by-name [r name path-params]
|
||||||
(if (= n name) (impl/fast-assoc match :path-params (impl/path-params path-params))))))))
|
(match-by-name r name path-params nil))
|
||||||
|
(match-by-name [_ name path-params opts]
|
||||||
|
(if (= n name) (impl/fast-assoc match :path-params (impl/path-params path-params opts))))))))
|
||||||
|
|
||||||
(defn mixed-router
|
(defn mixed-router
|
||||||
"Creates two routers: [[lookup-router]] or [[single-static-path-router]] for
|
"Creates two routers: [[lookup-router]] or [[single-static-path-router]] for
|
||||||
|
|
@ -262,9 +276,11 @@
|
||||||
(match-by-name [_ name]
|
(match-by-name [_ name]
|
||||||
(or (match-by-name static-router name)
|
(or (match-by-name static-router name)
|
||||||
(match-by-name wildcard-router name)))
|
(match-by-name wildcard-router name)))
|
||||||
(match-by-name [_ name path-params]
|
(match-by-name [r name path-params]
|
||||||
(or (match-by-name static-router name path-params)
|
(match-by-name r name path-params nil))
|
||||||
(match-by-name wildcard-router name path-params)))))))
|
(match-by-name [_ name path-params opts]
|
||||||
|
(or (match-by-name static-router name path-params opts)
|
||||||
|
(match-by-name wildcard-router name path-params opts)))))))
|
||||||
|
|
||||||
(defn quarantine-router
|
(defn quarantine-router
|
||||||
"Creates two routers: [[mixed-router]] for non-conflicting routes
|
"Creates two routers: [[mixed-router]] for non-conflicting routes
|
||||||
|
|
@ -293,9 +309,11 @@
|
||||||
(match-by-name [_ name]
|
(match-by-name [_ name]
|
||||||
(or (match-by-name mixed-router name)
|
(or (match-by-name mixed-router name)
|
||||||
(match-by-name linear-router name)))
|
(match-by-name linear-router name)))
|
||||||
(match-by-name [_ name path-params]
|
(match-by-name [r name path-params]
|
||||||
(or (match-by-name mixed-router name path-params)
|
(match-by-name r name path-params nil))
|
||||||
(match-by-name linear-router name path-params)))))))
|
(match-by-name [_ name path-params opts]
|
||||||
|
(or (match-by-name mixed-router name path-params opts)
|
||||||
|
(match-by-name linear-router name path-params opts)))))))
|
||||||
|
|
||||||
;;
|
;;
|
||||||
;; Creating Routers
|
;; Creating Routers
|
||||||
|
|
@ -307,6 +325,7 @@
|
||||||
:coerce (fn coerce [route _] route)
|
:coerce (fn coerce [route _] route)
|
||||||
:compile (fn compile [[_ {:keys [handler]}] _] handler)
|
:compile (fn compile [[_ {:keys [handler]}] _] handler)
|
||||||
:exception exception/exception
|
:exception exception/exception
|
||||||
|
:update-paths [[[:parameters any?] impl/accumulate]]
|
||||||
:conflicts (fn throw! [conflicts] (exception/fail! :path-conflicts conflicts))})
|
:conflicts (fn throw! [conflicts] (exception/fail! :path-conflicts conflicts))})
|
||||||
|
|
||||||
(defn router
|
(defn router
|
||||||
|
|
@ -314,20 +333,22 @@
|
||||||
Selects implementation based on route details. The following options
|
Selects implementation based on route details. The following options
|
||||||
are available:
|
are available:
|
||||||
|
|
||||||
| key | description
|
| key | description
|
||||||
| -------------|-------------
|
| ----------------|-------------
|
||||||
| `:path` | Base-path for routes
|
| `:path` | Base-path for routes
|
||||||
| `:routes` | Initial resolved routes (default `[]`)
|
| `:routes` | Initial resolved routes (default `[]`)
|
||||||
| `:data` | Initial route data (default `{}`)
|
| `:data` | Initial route data (default `{}`)
|
||||||
| `:spec` | clojure.spec definition for a route data, see `reitit.spec` on how to use this
|
| `:spec` | clojure.spec definition for a route data, see `reitit.spec` on how to use this
|
||||||
| `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon})
|
| `:syntax` | Path-parameter syntax as keyword or set of keywords (default #{:bracket :colon})
|
||||||
| `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`)
|
| `:expand` | Function of `arg opts => data` to expand route arg to route data (default `reitit.core/expand`)
|
||||||
| `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil`
|
| `:coerce` | Function of `route opts => route` to coerce resolved route, can throw or return `nil`
|
||||||
| `:compile` | Function of `route opts => result` to compile a route handler
|
| `:compile` | Function of `route opts => result` to compile a route handler
|
||||||
| `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects
|
| `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects
|
||||||
| `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes
|
| `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes
|
||||||
| `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`)
|
| `:exception` | Function of `Exception => Exception ` to handle creation time exceptions (default `reitit.exception/exception`)
|
||||||
| `:router` | Function of `routes opts => router` to override the actual router implementation"
|
| `:meta-merge` | Function of `left right => merged` to merge route-data (default `meta-merge.core/meta-merge`)
|
||||||
|
| `:update-paths` | Sequence of Vectors with elements `update-path` and `function`, used to preprocess route data
|
||||||
|
| `:router` | Function of `routes opts => router` to override the actual router implementation"
|
||||||
([raw-routes]
|
([raw-routes]
|
||||||
(router raw-routes {}))
|
(router raw-routes {}))
|
||||||
([raw-routes opts]
|
([raw-routes opts]
|
||||||
|
|
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
(ns reitit.dependency
|
|
||||||
"Dependency resolution for middleware/interceptors."
|
|
||||||
(:require [reitit.exception :as exception]))
|
|
||||||
|
|
||||||
(defn- providers
|
|
||||||
"Map from provision key to provider. `get-provides` should return the provision keys of a dependent."
|
|
||||||
[get-provides nodes]
|
|
||||||
(reduce (fn [acc dependent]
|
|
||||||
(into acc
|
|
||||||
(map (fn [provide]
|
|
||||||
(when (contains? acc provide)
|
|
||||||
(exception/fail!
|
|
||||||
(str "multiple providers for: " provide)
|
|
||||||
{::multiple-providers provide}))
|
|
||||||
[provide dependent]))
|
|
||||||
(get-provides dependent)))
|
|
||||||
{} nodes))
|
|
||||||
|
|
||||||
(defn- get-provider
|
|
||||||
"Get the provider for `k`, throw if no provider can be found for it."
|
|
||||||
[providers k]
|
|
||||||
(if (contains? providers k)
|
|
||||||
(get providers k)
|
|
||||||
(exception/fail!
|
|
||||||
(str "provider missing for dependency: " k)
|
|
||||||
{::missing-provider k})))
|
|
||||||
|
|
||||||
(defn post-order
|
|
||||||
"Put `nodes` in post-order. Can also be described as a reverse topological sort.
|
|
||||||
`get-provides` and `get-requires` are callbacks that you can provide to compute the provide and depend
|
|
||||||
key sets of nodes, the defaults are `:provides` and `:requires`."
|
|
||||||
([nodes] (post-order :provides :requires nodes))
|
|
||||||
([get-provides get-requires nodes]
|
|
||||||
(let [providers-by-key (providers get-provides nodes)]
|
|
||||||
(letfn [(toposort [node path colors]
|
|
||||||
(case (get colors node)
|
|
||||||
:white (let [requires (get-requires node)
|
|
||||||
[nodes* colors] (toposort-seq (map (partial get-provider providers-by-key) requires)
|
|
||||||
(conj path node)
|
|
||||||
(assoc colors node :grey))]
|
|
||||||
[(conj nodes* node)
|
|
||||||
(assoc colors node :black)])
|
|
||||||
:grey (exception/fail! "circular dependency" {:cycle (drop-while #(not= % node) (conj path node))})
|
|
||||||
:black [() colors]))
|
|
||||||
|
|
||||||
(toposort-seq [nodes path colors]
|
|
||||||
(reduce (fn [[nodes* colors] node]
|
|
||||||
(let [[nodes** colors] (toposort node path colors)]
|
|
||||||
[(into nodes* nodes**) colors]))
|
|
||||||
[[] colors] nodes))]
|
|
||||||
|
|
||||||
(first (toposort-seq nodes [] (zipmap nodes (repeat :white))))))))
|
|
||||||
|
|
@ -7,6 +7,10 @@
|
||||||
([type data]
|
([type data]
|
||||||
(throw (ex-info (str type) {:type type, :data data}))))
|
(throw (ex-info (str type) {:type type, :data data}))))
|
||||||
|
|
||||||
|
(defn unsupported-protocol-method!
|
||||||
|
[method]
|
||||||
|
(fail! :unsupported-protocol-method {:method method}))
|
||||||
|
|
||||||
(defn get-message [e]
|
(defn get-message [e]
|
||||||
#?(:clj (.getMessage ^Exception e) :cljs (ex-message e)))
|
#?(:clj (.getMessage ^Exception e) :cljs (ex-message e)))
|
||||||
|
|
||||||
|
|
|
||||||