mirror of
https://github.com/metosin/reitit.git
synced 2026-02-27 11:02:23 +00:00
Compare commits
No commits in common. "master" and "0.5.13" have entirely different histories.
219 changed files with 5935 additions and 10725 deletions
|
|
@ -1,7 +1,6 @@
|
|||
{;;:skip-comments true
|
||||
:lint-as {potemkin/def-derived-map clojure.core/defrecord
|
||||
clojure.test.check.clojure-test/defspec clojure.test/deftest}
|
||||
:linters {:missing-else-branch {:level :off}
|
||||
:lint-as {potemkin/def-derived-map clojure.core/defrecord}
|
||||
:linters {:if {:level :off}
|
||||
:unused-binding {:level :off}
|
||||
:unused-referred-var {:exclude {clojure.test [deftest testing is are]
|
||||
cljs.test [deftest testing is are]}}}}
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
{:config-paths ["../../../.clj-kondo"]}
|
||||
26
.github/workflows/release.yml
vendored
26
.github/workflows/release.yml
vendored
|
|
@ -1,26 +0,0 @@
|
|||
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
88
.github/workflows/testsuite.yml
vendored
|
|
@ -2,117 +2,77 @@ name: testsuite
|
|||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
pull_request:
|
||||
branches: [master]
|
||||
|
||||
jobs:
|
||||
build-clj:
|
||||
strategy:
|
||||
matrix:
|
||||
# Supported Java versions: LTS releases and latest
|
||||
jdk: [11, 17, 21, 25]
|
||||
clojure: [11, 12]
|
||||
# Supported Java versions: LTS releases 8 and 11 and the latest release
|
||||
jdk: [8, 11, 15]
|
||||
|
||||
name: Clojure ${{ matrix.clojure }} (Java ${{ matrix.jdk }})
|
||||
name: Clojure (Java ${{ matrix.jdk }})
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
- name: Cache dependencies
|
||||
uses: actions/cache@v4
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: ~/.m2/repository
|
||||
key: ${{ runner.os }}-clj-${{ hashFiles('**/project.clj') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-clj-
|
||||
|
||||
- name: Setup Java ${{ matrix.jdk }}
|
||||
uses: actions/setup-java@v4
|
||||
uses: actions/setup-java@v1.4.3
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: ${{ matrix.jdk }}
|
||||
|
||||
- name: Setup Clojure
|
||||
uses: DeLaGuardo/setup-clojure@13.1
|
||||
uses: DeLaGuardo/setup-clojure@3.1
|
||||
with:
|
||||
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
|
||||
run: ./scripts/test.sh clj${{ matrix.clojure }}
|
||||
run: ./scripts/test.sh clj
|
||||
|
||||
build-cljs:
|
||||
name: ClojureScript
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
- name: Cache dependencies
|
||||
uses: actions/cache@v4
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: |
|
||||
~/.m2/repository
|
||||
key: ${{ runner.os }}-cljs-${{ hashFiles('**/project.clj') }}
|
||||
**/node_modules
|
||||
key: ${{ runner.os }}-cljs-${{ hashFiles('**/project.clj', '**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-cljs-
|
||||
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v4
|
||||
- name: Setup Java 11
|
||||
uses: actions/setup-java@v1.4.3
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: 21
|
||||
|
||||
java-version: 11
|
||||
- name: Setup Clojure
|
||||
uses: DeLaGuardo/setup-clojure@13.1
|
||||
uses: DeLaGuardo/setup-clojure@3.1
|
||||
with:
|
||||
lein: 2.9.5
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
uses: actions/setup-node@v2.1.2
|
||||
with:
|
||||
node-version: 22
|
||||
cache: npm
|
||||
|
||||
node-version: 12
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
run: |
|
||||
npm ci
|
||||
- name: Install modules
|
||||
run: ./scripts/lein-modules install
|
||||
- name: Run tests
|
||||
run: ./scripts/test.sh cljs
|
||||
|
||||
lint:
|
||||
name: Lint cljdoc.edn
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
- name: Verify 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
|
||||
|
|
|
|||
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -13,6 +13,4 @@ pom.xml.asc
|
|||
/_book
|
||||
figwheel_server.log
|
||||
/.idea
|
||||
.clj-kondo
|
||||
.shadow-cljs
|
||||
.cache
|
||||
.clj-kondo
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
{:cljfmt {:indents {for-all [[:inner 0]]
|
||||
are [[:inner 0]]}}
|
||||
:clean {:ns-inner-blocks-indentation :same-line}}
|
||||
431
CHANGELOG.md
431
CHANGELOG.md
|
|
@ -12,379 +12,8 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
|
|||
|
||||
[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)
|
||||
|
||||
**[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)
|
||||
* Frontend: provide easy way to update current query params. [#600](https://github.com/metosin/reitit/issues/600)
|
||||
* Updated dependencies:
|
||||
|
||||
```clojure
|
||||
[metosin/ring-swagger-ui "4.18.1"] is available but we use "4.15.5"
|
||||
[metosin/malli "0.11.0"] is available but we use "0.10.1"
|
||||
[ring/ring-core "1.10.0"] is available but we use "1.9.6"
|
||||
```
|
||||
|
||||
## 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)
|
||||
* reloading-ring-handler [#584](https://github.com/metosin/reitit/pull/584)
|
||||
* Remove redundant s/and [#552](https://github.com/metosin/reitit/pull/552)
|
||||
* FIX: redirect-trailing-slash-handler strips query-params [#565](https://github.com/metosin/reitit/issues/565)
|
||||
* **BREAKING**: Drop tests for Clojure 1.9, run tests with 1.10 & 1.11
|
||||
* NEW option `:meta-merge` on a router for custom merge strategy on route data
|
||||
* Swagger: support operationId in generated swagger json [#452](https://github.com/metosin/reitit/pull/452) & [#569](https://github.com/metosin/reitit/pull/569)
|
||||
* Update documentation and link to the startrek project [#578](https://github.com/metosin/reitit/pull/578)
|
||||
* Upgrade jackson for CVE-2022-42003 and CVE-2022-42004 [#577](https://github.com/metosin/reitit/pull/577)
|
||||
* Improved coercion errors perf [#576](https://github.com/metosin/reitit/pull/576)
|
||||
* Add example for Reitit + Pedestal + Malli coercion [#572](https://github.com/metosin/reitit/pull/572)
|
||||
* Handle empty seq as empty string in query-string [#566](https://github.com/metosin/reitit/pull/566)
|
||||
* Polish pedestal chains when printing context diffs [#557](https://github.com/metosin/reitit/pull/557)
|
||||
* Updated dependencies:
|
||||
|
||||
```clojure
|
||||
[metosin/ring-swagger-ui "4.15.5"] is available but we use "4.3.0"
|
||||
[metosin/jsonista "0.3.7"] is available but we use "0.3.5"
|
||||
[metosin/malli "0.10.1"] is available but we use "0.8.2"
|
||||
[fipp "0.6.26"] is available but we use "0.6.25"
|
||||
[ring/ring-core "1.9.6"] is available but we use "1.9.5"
|
||||
[com.fasterxml.jackson.core/jackson-core "2.14.2"] is available but we use "2.14.1"
|
||||
[com.fasterxml.jackson.core/jackson-databind "2.14.2"] is available but we use "2.14.1"
|
||||
```
|
||||
|
||||
## 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))
|
||||
* 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)
|
||||
* Balance parenthesis in docs [#547](https://github.com/metosin/reitit/pull/547)
|
||||
|
||||
## 0.5.17 (2022-03-10)
|
||||
|
||||
**[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)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.15...0.5.16)**
|
||||
|
||||
* Support for [Malli Lite Syntax](https://github.com/metosin/malli#lite) in coercion (enabled by default):
|
||||
|
||||
```clj
|
||||
["/add/:id" {:post {:parameters {:path {:id int?}
|
||||
:query {:a (l/optional int?)}
|
||||
:body {:id int?
|
||||
:data {:id (l/maybe int?)
|
||||
:orders (l/map-of uuid? {:name string?})}}}
|
||||
:responses {200 {:body {:total pos-int?}}
|
||||
500 {:description "fail"}}}}]
|
||||
```
|
||||
|
||||
* Improved Reitit-frontend function docstrings
|
||||
|
||||
* Updated deps:
|
||||
|
||||
```clj
|
||||
[metosin/ring-swagger-ui "4.3.0"] is available but we use "3.46.0"
|
||||
[metosin/jsonista "0.3.5"] is available but we use "0.3.3"
|
||||
[metosin/malli "0.8.2"] is available but we use "0.5.1"
|
||||
[com.fasterxml.jackson.core/jackson-core "2.13.1"] is available but we use "2.12.4"
|
||||
[com.fasterxml.jackson.core/jackson-databind "2.13.1"] is available but we use "2.12.4"
|
||||
[fipp "0.6.25"] is available but we use "0.6.24"
|
||||
[expound "0.9.0"] is available but we use "0.8.9"
|
||||
[ring/ring-core "1.9.5"] is available but we use "1.9.4"
|
||||
```
|
||||
|
||||
## 0.5.15 (2021-08-05)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.14...0.5.15)**
|
||||
|
||||
* recompiled with Java8
|
||||
|
||||
## 0.5.14 (2021-08-03)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.13...0.5.14)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```clj
|
||||
[metosin/ring-swagger-ui "3.46.0"] is available but we use "3.36.0"
|
||||
[metosin/jsonista "0.3.3"] is available but we use "0.3.1"
|
||||
[metosin/malli "0.5.1"] is available but we use "0.3.0"
|
||||
[com.fasterxml.jackson.core/jackson-core "2.12.4"] is available but we use "2.12.1"
|
||||
[com.fasterxml.jackson.core/jackson-databind "2.12.4"] is available but we use "2.12.1"
|
||||
[fipp "0.6.24"] is available but we use "0.6.23"
|
||||
[ring/ring-core "1.9.4"] is available but we use "1.9.1"
|
||||
[io.pedestal/pedestal.service "0.5.9"] is available but we use "0.5.8"
|
||||
```
|
||||
|
||||
### `reitit-ring`
|
||||
|
||||
* Fixes `reitit.ring/create-resource-handler` and `reitit.ring/create-file-handler` to support URL-escaped characters. [#484](https://github.com/metosin/reitit/issues/484). PR [#489](https://github.com/metosin/reitit/pull/489).
|
||||
|
||||
### `reitit-malli`
|
||||
|
||||
* FIX: Malli response coercision seems to do nothing at all [#498](https://github.com/metosin/reitit/pull/501)
|
||||
|
||||
### `reitit-pedestal`
|
||||
|
||||
* Enrich request for pedestal/routing-interceptor default-queue [#495](https://github.com/metosin/reitit/pull/495)
|
||||
|
||||
## 0.5.13 (2021-04-23)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.12...0.5.13)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```clj
|
||||
|
|
@ -402,8 +31,6 @@ The OpenAPI3 release, Year in the making - the changes span over multiple reposi
|
|||
|
||||
## 0.5.12 (2021-02-01)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.11...0.5.12)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```
|
||||
|
|
@ -420,8 +47,6 @@ The OpenAPI3 release, Year in the making - the changes span over multiple reposi
|
|||
|
||||
## 0.5.11 (2020-12-27)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.10...0.5.11)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```clj
|
||||
|
|
@ -433,8 +58,6 @@ The OpenAPI3 release, Year in the making - the changes span over multiple reposi
|
|||
|
||||
## 0.5.10 (2020-10-22)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.9...0.5.10)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```clj
|
||||
|
|
@ -447,8 +70,6 @@ The OpenAPI3 release, Year in the making - the changes span over multiple reposi
|
|||
|
||||
## 0.5.9 (2020-10-19)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.8...0.5.9)**
|
||||
|
||||
### `reitit-frontend`
|
||||
|
||||
- `reitit.frontend.easy/start!` now correctly removes old event listeners
|
||||
|
|
@ -457,14 +78,10 @@ when called repeatedly (e.g. with hot code reload workflow)
|
|||
|
||||
## 0.5.8 (2020-10-19)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.7...0.5.8)**
|
||||
|
||||
* Add `:conflicting` to route data spec [#444](https://github.com/metosin/reitit/pull/444).
|
||||
|
||||
## 0.5.7 (2020-10-18)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.6...0.5.7)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```clj
|
||||
|
|
@ -482,8 +99,6 @@ when called repeatedly (e.g. with hot code reload workflow)
|
|||
|
||||
## 0.5.6 (2020-09-26)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.5...0.5.6)**
|
||||
|
||||
* updated deps:
|
||||
|
||||
```clj
|
||||
|
|
@ -496,20 +111,18 @@ when called repeatedly (e.g. with hot code reload workflow)
|
|||
|
||||
### `reitit-malli`
|
||||
|
||||
* `:map-of` keys in JSON are correctly decoded using string-decoders
|
||||
* `:map-of` keys in JSON are correctly decoded using string-decoders
|
||||
* new `:encode-error` option in coercion:
|
||||
|
||||
```clj
|
||||
(def coercion
|
||||
(reitit.coercion.malli/create
|
||||
(def coercion
|
||||
(reitit.coercion.malli/create
|
||||
{:encode-error (fn [error] {:errors (:humanized error)})}))
|
||||
; results in... => {:status 400, :body {:errors {:x ["missing required key"]}}}
|
||||
```
|
||||
|
||||
## 0.5.5 (2020-07-15)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.4...0.5.5)**
|
||||
|
||||
* recompile with Java8
|
||||
|
||||
```clj
|
||||
|
|
@ -518,24 +131,18 @@ when called repeatedly (e.g. with hot code reload workflow)
|
|||
|
||||
## 0.5.4 (2020-07-13)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.3...0.5.4)**
|
||||
|
||||
```clj
|
||||
[metosin/malli "0.0.1-20200713.080243-20"] is available but we use "0.0.1-20200709.163702-18"
|
||||
```
|
||||
|
||||
## 0.5.3 (2020-07-09)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.2...0.5.3)**
|
||||
|
||||
```clj
|
||||
[metosin/malli "0.0.1-20200709.163702-18"] is available but we use "0.0.1-20200525.162645-15"
|
||||
```
|
||||
|
||||
## 0.5.2 (2020-05-27)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.1...0.5.2)**
|
||||
|
||||
```clj
|
||||
[metosin/malli "0.0.1-20200525.162645-15"] is available but we use "0.0.1-20200404.091302-14"
|
||||
```
|
||||
|
|
@ -561,8 +168,6 @@ when called repeatedly (e.g. with hot code reload workflow)
|
|||
|
||||
## 0.5.1 (2020-05-18)
|
||||
|
||||
**[compare](https://github.com/metosin/reitit/compare/0.5.0...0.5.1)**
|
||||
|
||||
```clj
|
||||
[metosin/sieppari "0.0.0-alpha13"] is available but we use "0.0.0-alpha10"
|
||||
```
|
||||
|
|
@ -611,13 +216,13 @@ is called the first time, so that `rfe/push-state` and such can be called
|
|||
|
||||
* `reitit.ring/routes` strips away `nil` routes, fixes [#394](https://github.com/metosin/reitit/issues/394)
|
||||
* `reitit.ring/create-file-handler` to serve files from filesystem, fixes [#395](https://github.com/metosin/reitit/issues/395)
|
||||
* **BREAKING**: router option `:reitit.ring/default-options-handler` is deprecated
|
||||
* **BREAKING**: router option `:reitit.ring/default-options-handler` is deprecated
|
||||
* fails with router creation time error
|
||||
* use `:reitit.ring/default-options-endpoint` instead, takes an expandable route data instead just of a handler.
|
||||
|
||||
### `reitit-http`
|
||||
|
||||
* **BREAKING**: router option `:reitit.http/default-options-handler` is deprecated
|
||||
* **BREAKING**: router option `:reitit.http/default-options-handler` is deprecated
|
||||
* fails with router creation time error
|
||||
* use `:reitit.http/default-options-endpoint` instead, takes an expandable route data instead just of a handler.
|
||||
|
||||
|
|
@ -696,7 +301,7 @@ is called the first time, so that `rfe/push-state` and such can be called
|
|||
|
||||
* **BREAKING**: Decode multi-valued query params correctly into seqs (e.g. `foo=bar&foo=baz` ↦ `{:foo ["bar", "baz"]}`).
|
||||
* Previously you'd get only the first value. (e.g. `foo=bar&foo=baz` ↦ `{:foo "bar"}`)
|
||||
|
||||
|
||||
### `reitit-ring`
|
||||
|
||||
* **BREAKING**: New validation rule: `:middleware` must be a vector, not a list. Fixes [#296](https://github.com/metosin/reitit/issues/296). ([#319](https://github.com/metosin/reitit/pull/319) by [Daw-Ran Liou](https://github.com/dawran6))
|
||||
|
|
@ -814,23 +419,23 @@ is called the first time, so that `rfe/push-state` and such can be called
|
|||
{:parameters {:body [s/Str]}}]]
|
||||
{:exception pretty/exception})
|
||||
; -- Router creation failed -------------------------------------------- user:7 --
|
||||
;
|
||||
;
|
||||
; Error merging route-data:
|
||||
;
|
||||
;
|
||||
; -- On route -----------------------
|
||||
;
|
||||
;
|
||||
; /kikka/kakka
|
||||
;
|
||||
;
|
||||
; -- Exception ----------------------
|
||||
;
|
||||
;
|
||||
; Don't know how to create ISeq from: java.lang.Class
|
||||
;
|
||||
;
|
||||
; {:parameters {:body {:id java.lang.String}}}
|
||||
;
|
||||
;
|
||||
; {:parameters {:body [java.lang.String]}}
|
||||
;
|
||||
;
|
||||
; https://cljdoc.org/d/metosin/reitit/CURRENT/doc/basics/route-data
|
||||
;
|
||||
;
|
||||
; --------------------------------------------------------------------------------
|
||||
```
|
||||
|
||||
|
|
@ -849,7 +454,7 @@ is called the first time, so that `rfe/push-state` and such can be called
|
|||
|
||||
### `reitit-core`
|
||||
|
||||
* new options `:reitit.spec/wrap` to wrap top-level route data specs when spec validation is enabled. Using `spec-tools.spell/closed` closes top-level specs.
|
||||
* new options `:reitit.spec/wrap` to wrap top-level route data specs when spec validation is enabled. Using `spec-tools.spell/closed` closes top-level specs.
|
||||
* Updated swagger-examples to easily enable closed spec validation
|
||||
|
||||
```clj
|
||||
|
|
@ -914,9 +519,9 @@ is called the first time, so that `rfe/push-state` and such can be called
|
|||
* new module for friendly router creation time exception handling
|
||||
* new option `:exception` in `r/router`, of type `Exception => Exception` (default `reitit.exception/exception`)
|
||||
* new exception pretty-printer `reitit.dev.pretty/exception`, based on [fipp](https://github.com/brandonbloom/fipp) and [expound](https://github.com/bhb/expound) for human readable, newbie-friendly errors.
|
||||
|
||||
|
||||
#### Conflicting paths
|
||||
|
||||
|
||||
```clj
|
||||
(require '[reitit.core :as r])
|
||||
(require '[reitit.dev.pretty :as pretty])
|
||||
|
|
|
|||
10
Justfile
Normal file
10
Justfile
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
help:
|
||||
@just --list
|
||||
|
||||
# Initializes lint
|
||||
init-lint:
|
||||
clj-kondo --lint $(lein classpath)
|
||||
|
||||
# Lints the project
|
||||
lint:
|
||||
./lint.sh
|
||||
116
README.md
116
README.md
|
|
@ -1,11 +1,5 @@
|
|||
# reitit
|
||||
# reitit [](https://github.com/metosin/reitit/actions?query=workflow%3Atestsuite) [](https://cljdoc.org/jump/release/metosin/reitit) [](https://clojurians.slack.com/messages/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).
|
||||
|
||||
* Simple data-driven [route syntax](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/basics/route-syntax/)
|
||||
|
|
@ -26,36 +20,26 @@ Presentations:
|
|||
* [Data-Driven Ring with Reitit](https://www.metosin.fi/blog/reitit-ring/)
|
||||
* [Reitit, Data-Driven Routing with Clojure(Script)](https://www.metosin.fi/blog/reitit/)
|
||||
|
||||
**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)
|
||||
|
||||
There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians Slack](http://clojurians.net/) for discussion & help.
|
||||
|
||||
## Main Modules
|
||||
|
||||
* `metosin/reitit` - all bundled
|
||||
* `metosin/reitit-core` - the routing core
|
||||
* `metosin/reitit-ring` - a [ring router](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/ring-router/)
|
||||
* `metosin/reitit-middleware` - [common middleware](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/default-middleware/)
|
||||
* `metosin/reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion
|
||||
* `metosin/reitit-malli` [malli](https://github.com/metosin/malli) coercion
|
||||
* `metosin/reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
||||
* `fi.metosin/reitit-openapi` [OpenAPI](https://www.openapis.org/) apidocs *
|
||||
* `metosin/reitit-swagger` [Swagger2](https://swagger.io/) apidocs
|
||||
* `metosin/reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui)
|
||||
* `metosin/reitit-frontend` Tools for [frontend routing]((https://cljdoc.org/d/metosin/reitit/CURRENT/doc/frontend/basics/))
|
||||
* `metosin/reitit-http` http-routing with Interceptors
|
||||
* `metosin/reitit-interceptors` - [common interceptors](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/http/default-interceptors/)
|
||||
* `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.
|
||||
* `reitit` - all bundled
|
||||
* `reitit-core` - the routing core
|
||||
* `reitit-ring` - a [ring router](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/ring/ring/)
|
||||
* `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
|
||||
* `reitit-malli` [malli](https://github.com/metosin/malli) coercion
|
||||
* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
||||
* `reitit-swagger` [Swagger2](https://swagger.io/) apidocs
|
||||
* `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui)
|
||||
* `reitit-frontend` Tools for [frontend routing]((https://cljdoc.org/d/metosin/reitit/CURRENT/doc/frontend/basics/))
|
||||
* `reitit-http` http-routing with Interceptors
|
||||
* `reitit-interceptors` - [common interceptors](https://cljdoc.org/d/metosin/reitit/CURRENT/doc/http/default-interceptors/)
|
||||
* `reitit-sieppari` support for [Sieppari](https://github.com/metosin/sieppari)
|
||||
* `reitit-dev` - development utilities
|
||||
|
||||
## Extra modules
|
||||
|
||||
|
|
@ -66,15 +50,11 @@ modules will continue to be released under `metosin` for compatibility purposes.
|
|||
All main modules bundled:
|
||||
|
||||
```clj
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
```clj
|
||||
|
|
@ -109,7 +89,6 @@ A Ring routing app with input & output coercion using [data-specs](https://githu
|
|||
(require '[reitit.ring :as ring])
|
||||
(require '[reitit.coercion.spec])
|
||||
(require '[reitit.ring.coercion :as rrc])
|
||||
(require '[reitit.ring.middleware.exception :as exception])
|
||||
(require '[reitit.ring.middleware.muuntaja :as muuntaja])
|
||||
(require '[reitit.ring.middleware.parameters :as parameters])
|
||||
|
||||
|
|
@ -125,50 +104,44 @@ A Ring routing app with input & output coercion using [data-specs](https://githu
|
|||
;; router data affecting all routes
|
||||
{:data {:coercion reitit.coercion.spec/coercion
|
||||
:muuntaja m/instance
|
||||
:middleware [parameters/parameters-middleware ; decoding query & form params
|
||||
muuntaja/format-middleware ; content negotiation
|
||||
exception/exception-middleware ; converting exceptions to HTTP responses
|
||||
:middleware [parameters/parameters-middleware
|
||||
rrc/coerce-request-middleware
|
||||
rrc/coerce-response-middleware]}})))
|
||||
rrc/coerce-response-middleware
|
||||
muuntaja/format-response-middleware]}})))
|
||||
```
|
||||
|
||||
Valid request:
|
||||
|
||||
```clj
|
||||
(-> (app {:request-method :get
|
||||
:uri "/api/math"
|
||||
:query-params {:x "1", :y "2"}})
|
||||
(update :body slurp))
|
||||
(app {:request-method :get
|
||||
:uri "/api/math"
|
||||
:query-params {:x "1", :y "2"}})
|
||||
; {:status 200
|
||||
; :body "{\"total\":3}"
|
||||
; :headers {"Content-Type" "application/json; charset=utf-8"}}
|
||||
; :body {:total 3}}
|
||||
```
|
||||
|
||||
Invalid request:
|
||||
|
||||
```clj
|
||||
(-> (app {:request-method :get
|
||||
:uri "/api/math"
|
||||
:query-params {:x "1", :y "a"}})
|
||||
(update :body jsonista.core/read-value))
|
||||
; {:status 400
|
||||
; :headers {"Content-Type" "application/json; charset=utf-8"}
|
||||
; :body {"spec" "(spec-tools.core/spec {:spec (clojure.spec.alpha/keys :req-un [:spec$8974/x :spec$8974/y]), :type :map, :leaf? false})"
|
||||
; "value" {"x" "1"
|
||||
; "y" "a"}
|
||||
; "problems" [{"via" ["spec$8974/y"]
|
||||
; "path" ["y"]
|
||||
; "pred" "clojure.core/int?"
|
||||
; "in" ["y"]
|
||||
; "val" "a"}]
|
||||
; "type" "reitit.coercion/request-coercion"
|
||||
; "coercion" "spec"
|
||||
; "in" ["request" "query-params"]}}
|
||||
(app {:request-method :get
|
||||
:uri "/api/math"
|
||||
:query-params {:x "1", :y "a"}})
|
||||
;{:status 400,
|
||||
; :body {:type :reitit.coercion/request-coercion,
|
||||
; :coercion :spec,
|
||||
; :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}})",
|
||||
; :problems [{:path [:y],
|
||||
; :pred "clojure.core/int?",
|
||||
; :val "a",
|
||||
; :via [:$spec20745/y],
|
||||
; :in [:y]}],
|
||||
; :value {:x "1", :y "a"},
|
||||
; :in [:request :query-params]}}
|
||||
```
|
||||
|
||||
## More examples
|
||||
|
||||
* [`reitit-ring` with coercion, swagger and default middleware](https://github.com/metosin/reitit/blob/master/examples/ring-malli-swagger/src/example/server.clj)
|
||||
* [`reitit-ring` with coercion, swagger and default middleware](https://github.com/metosin/reitit/blob/master/examples/ring-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` 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)
|
||||
|
|
@ -178,17 +151,12 @@ All examples are in https://github.com/metosin/reitit/tree/master/examples
|
|||
|
||||
## External resources
|
||||
* Simple web application using Ring/Reitit and Integrant: https://github.com/PrestanceDesign/usermanager-reitit-integrant-example
|
||||
* A simple Clojure backend using Reitit to serve up a RESTful API: [startrek](https://github.com/dharrigan/startrek). Technologies include:
|
||||
* [Donut System](https://github.com/donut-party/system)
|
||||
* [next-jdbc](https://github.com/seancorfield/next-jdbc)
|
||||
* [JUXT Clip](https://github.com/juxt/clip)
|
||||
* [Flyway](https://github.com/flyway/flyway)
|
||||
* [HoneySQL](https://github.com/seancorfield/honeysql)
|
||||
* [Babashka](https://babashka.org)
|
||||
* A simple [ClojureScript](https://clojurescript.org/) frontend and Clojure backend using Reitit, [JUXT Clip](https://github.com/juxt/clip), [next.jdbc](https://github.com/seancorfield/next-jdbc) and other bits and bobs...
|
||||
* [startrek](https://git.sr.ht/~dharrigan/startrek)
|
||||
* [startrek-ui](https://git.sr.ht/~dharrigan/startrek-ui)
|
||||
* https://www.learnreitit.com/
|
||||
* Lipas, liikuntapalvelut: https://github.com/lipas-liikuntapaikat/lipas
|
||||
* Implementation of the Todo-Backend API spec, using Clojure, Ring/Reitit and next-jdbc: https://github.com/PrestanceDesign/todo-backend-clojure-reitit
|
||||
* Ping CRM, a single page app written in Clojure Ring, Reitit, Integrant and next.jdbc: https://github.com/prestancedesign/clojure-inertia-pingcrm-demo
|
||||
|
||||
## More info
|
||||
|
||||
|
|
@ -209,6 +177,6 @@ Roadmap is mostly written in [issues](https://github.com/metosin/reitit/issues).
|
|||
|
||||
## License
|
||||
|
||||
Copyright © 2017-2023 [Metosin Oy](http://www.metosin.fi)
|
||||
Copyright © 2017-2021 [Metosin Oy](http://www.metosin.fi)
|
||||
|
||||
Distributed under the Eclipse Public License, the same as Clojure.
|
||||
|
|
|
|||
26
bb.edn
26
bb.edn
|
|
@ -1,26 +0,0 @@
|
|||
{: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"))}}}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
{
|
||||
"name": "Example"
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
hello
|
||||
|
|
@ -24,7 +24,6 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
|
|||
* `reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion
|
||||
* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion
|
||||
* `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-frontend` Tools for [frontend routing](frontend/basics.md)
|
||||
* `reitit-http` http-routing with Pedestal-style Interceptors
|
||||
|
|
@ -41,7 +40,7 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
|
|||
All bundled:
|
||||
|
||||
```clj
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
```
|
||||
|
||||
Optionally, the parts can be required separately.
|
||||
|
|
@ -111,9 +110,9 @@ Reverse-routing:
|
|||
; :path "/api/orders/2"}
|
||||
```
|
||||
|
||||
## Ring router
|
||||
## Ring-router
|
||||
|
||||
A Ring router function adds support for `:handler` functions, `:middleware` and routing based on `:request-method`. It also supports pluggable parameter coercion (`clojure.spec`), data-driven middleware, route and middleware compilation, dynamic extensions and more.
|
||||
Ring-router adds support for `:handler` functions, `:middleware` and routing based on `:request-method`. It also supports pluggable parameter coercion (`clojure.spec`), data-driven middleware, route and middleware compilation, dynamic extensions and more.
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring :as ring])
|
||||
|
|
@ -140,7 +139,7 @@ Routing:
|
|||
|
||||
```clj
|
||||
(app {:request-method :get, :uri "/api/admin/users"})
|
||||
; {:status 200, :body "ok", :wrap (:api :admin)}
|
||||
; {:status 200, :body "ok", :wrap (:api :admin}
|
||||
|
||||
(app {:request-method :put, :uri "/api/admin/users"})
|
||||
; nil
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
|
||||
## Ring
|
||||
|
||||
* [Ring Router](ring/ring.md)
|
||||
* [Ring-router](ring/ring.md)
|
||||
* [Reverse-routing](ring/reverse_routing.md)
|
||||
* [Default handler](ring/default_handler.md)
|
||||
* [Slash handler](ring/slash_handler.md)
|
||||
|
|
@ -41,7 +41,6 @@
|
|||
* [Route Data Validation](ring/route_data_validation.md)
|
||||
* [Compiling Middleware](ring/compiling_middleware.md)
|
||||
* [Swagger Support](ring/swagger.md)
|
||||
* [OpenAPI Support](ring/openapi.md)
|
||||
* [RESTful form methods](ring/RESTful_form_methods.md)
|
||||
|
||||
## HTTP
|
||||
|
|
|
|||
|
|
@ -143,10 +143,10 @@ As the `Match` contains all the route data, we can create a new matching functio
|
|||
(require '[clojure.string :as str])
|
||||
|
||||
(defn recursive-match-by-path [router path]
|
||||
(when-let [match (r/match-by-path router path)]
|
||||
(if-let [match (r/match-by-path router path)]
|
||||
(if-let [subrouter (-> match :data :router)]
|
||||
(let [subpath (subs path (str/last-index-of (:template match) "/"))]
|
||||
(when-let [submatch (recursive-match-by-path subrouter subpath)]
|
||||
(if-let [submatch (recursive-match-by-path subrouter subpath)]
|
||||
(cons match submatch)))
|
||||
(list match))))
|
||||
```
|
||||
|
|
@ -206,10 +206,10 @@ First, we need to modify our matching function to support router references:
|
|||
(deref x) x))
|
||||
|
||||
(defn recursive-match-by-path [router path]
|
||||
(when-let [match (r/match-by-path (<< router) path)]
|
||||
(if-let [match (r/match-by-path (<< router) path)]
|
||||
(if-let [subrouter (-> match :data :router <<)]
|
||||
(let [subpath (subs path (str/last-index-of (:template match) "/"))]
|
||||
(when-let [submatch (recursive-match-by-path subrouter subpath)]
|
||||
(if-let [submatch (recursive-match-by-path subrouter subpath)]
|
||||
(cons match submatch)))
|
||||
(list match))))
|
||||
```
|
||||
|
|
@ -405,53 +405,9 @@ All the beer-routes now match in constant time.
|
|||
|-----------------|---------|-----------------------
|
||||
| `/beers/sahti` | 40ns | static
|
||||
|
||||
### Wrapping a swappable ring handler
|
||||
|
||||
In order for a ring handler to be recomposed, we can wrap it into a handler that dereferences it on request.
|
||||
|
||||
```clj
|
||||
(defn deref-handler [rf]
|
||||
(fn
|
||||
([request] (@rf request))
|
||||
([request respond raise] (@rf request respond raise))))
|
||||
```
|
||||
|
||||
A simplified beer router version that creates a ring-handler.
|
||||
|
||||
```clj
|
||||
(defn create-ring-handler [beers]
|
||||
(ring/ring-handler
|
||||
(ring/router
|
||||
[["/beers"
|
||||
(when (seq beers)
|
||||
(for [beer beers]
|
||||
[(str "/" beer)
|
||||
{:get (fn [_] {:status 200 :body beer})}]))]])))
|
||||
|
||||
(def ring-handler
|
||||
(atom (create-ring-handler nil)))
|
||||
|
||||
(defn reset-router! [beers]
|
||||
(reset! ring-handler (create-ring-handler beers)))
|
||||
```
|
||||
|
||||
We don't have any matching routes yet.
|
||||
|
||||
```clj
|
||||
((deref-handler ring-handler) {:request-method :get :uri "/beers/lager"})
|
||||
; nil
|
||||
```
|
||||
|
||||
But we can add them later.
|
||||
|
||||
```clj
|
||||
(reset-router! ["lager"])
|
||||
((deref-handler ring-handler) {:request-method :get :uri "/beers/lager"})
|
||||
; {:status 200, :body "lager"}
|
||||
```
|
||||
|
||||
## TODO
|
||||
|
||||
* add an example how to do dynamic routing with `reitit-ring`
|
||||
* maybe create a `recursive-router` into a separate ns with all `Router` functions implemented correctly? maybe not...
|
||||
* add `reitit.core/merge-routes` to effectively merge routes with route data
|
||||
|
||||
|
|
|
|||
|
|
@ -2,21 +2,17 @@
|
|||
|
||||
Routers can be configured via options. The following options are available for the `reitit.core/router`:
|
||||
|
||||
| key | description
|
||||
|-----------------|-------------
|
||||
| `:path` | Base-path for routes
|
||||
| `:routes` | Initial resolved routes (default `[]`)
|
||||
| `:data` | Initial route data (default `{}`)
|
||||
| `: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})
|
||||
| `: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`
|
||||
| `:compile` | Function of `route opts => result` to compile a route handler
|
||||
| `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects
|
||||
| `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes
|
||||
| `: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`)
|
||||
| `: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
|
||||
|
||||
|
||||
| key | description
|
||||
|--------------|-------------
|
||||
| `:path` | Base-path for routes
|
||||
| `:routes` | Initial resolved routes (default `[]`)
|
||||
| `:data` | Initial route data (default `{}`)
|
||||
| `: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})
|
||||
| `: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`
|
||||
| `:compile` | Function of `route opts => result` to compile a route handler
|
||||
| `:validate` | Function of `routes opts => ()` to validate route (data) via side-effects
|
||||
| `:conflicts` | Function of `{route #{route}} => ()` to handle conflicting routes
|
||||
| `: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
|
||||
|
|
|
|||
|
|
@ -147,19 +147,3 @@ 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 !
|
||||
|
||||
## 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
|
||||
|
||||
```clj
|
||||
[metosin/reitit-dev "0.10.0"]
|
||||
[metosin/reitit-dev "0.5.13"]
|
||||
```
|
||||
|
||||
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,17 +75,6 @@ Path-parameters are automatically coerced into strings, with the help of (curren
|
|||
; :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:
|
||||
|
||||
```clj
|
||||
|
|
@ -108,5 +97,5 @@ It can take an optional map of query-parameters too:
|
|||
(-> router
|
||||
(r/match-by-name ::user {:id 1})
|
||||
(r/match->path {:iso "möly"}))
|
||||
; "/api/user/1?iso=m%C3%B6ly"
|
||||
; "/api/user/1?iso=m%C3%B6ly"
|
||||
```
|
||||
|
|
|
|||
|
|
@ -9,10 +9,9 @@ Route data is the key feature of reitit. Routes can have any map-like data attac
|
|||
: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` (see [Name-based Routing](./name_based_routing.md))
|
||||
and functions into `:handler` keys.
|
||||
By default, Keywords are expanded into `:name` and functions into `:handler` keys.
|
||||
|
||||
```clj
|
||||
(require '[reitit.core :as r])
|
||||
|
|
@ -80,13 +79,11 @@ Resolved route tree:
|
|||
; :name :user/ping}]
|
||||
; ["/api/admin/users" {:interceptors [::api]
|
||||
; :roles #{:admin}
|
||||
; :name ::users}]
|
||||
; :name ::users} nil]
|
||||
; ["/api/admin/db" {:interceptors [::api ::db]
|
||||
; :roles #{:db-admin}}]]
|
||||
```
|
||||
|
||||
See also [nested parameter definitions for coercions](../ring/coercion.md#nested-parameter-definitions)
|
||||
|
||||
## 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.
|
||||
|
|
@ -120,7 +117,7 @@ Accumulated route data:
|
|||
["/api-docs" ::api-docs]]
|
||||
["/api/ping" ::ping]
|
||||
["/api/pong" ::pong]]))
|
||||
|
||||
|
||||
(r/routes router)
|
||||
; [["/swagger.json" {:no-doc true, :name ::swagger}]
|
||||
; ["/api-docs" {:no-doc true, :name ::api-docs}]
|
||||
|
|
|
|||
|
|
@ -1,9 +1,6 @@
|
|||
# Route Syntax
|
||||
|
||||
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 are defined as vectors of String path and optional (non-sequential) route argument child routes.
|
||||
|
||||
Routes can be wrapped in vectors and lists and `nil` routes are ignored.
|
||||
|
||||
|
|
@ -14,38 +11,43 @@ Paths can have path-parameters (`:id`) or catch-all-parameters (`*path`). Parame
|
|||
Simple route:
|
||||
|
||||
```clj
|
||||
["/ping" {:handler ping}]
|
||||
["/ping"]
|
||||
```
|
||||
|
||||
Two routes with more data:
|
||||
Two routes:
|
||||
|
||||
```clj
|
||||
[["/ping" {:handler ping
|
||||
:cost 300}]
|
||||
["/pong" {:handler pong
|
||||
:tags #{:game}}]]
|
||||
[["/ping"]
|
||||
["/pong"]]
|
||||
```
|
||||
|
||||
Routes with path parameters (see also [Coercion](../coercion/coercion.md) and [Ring Coercion](../ring/coercion.md)):
|
||||
Routes with route arguments:
|
||||
|
||||
```clj
|
||||
[["/users/:user-id" {:handler get-user}]
|
||||
["/api/:version/ping" {:handler ping-version}]]
|
||||
[["/ping" ::ping]
|
||||
["/pong" {:name ::pong}]]
|
||||
```
|
||||
|
||||
Routes with path parameters:
|
||||
|
||||
```clj
|
||||
[["/users/:user-id"]
|
||||
["/api/:version/ping"]]
|
||||
```
|
||||
|
||||
```clj
|
||||
[["/users/{user-id}" {:handler get-user}]
|
||||
["/files/file-{number}.pdf" {:handler get-pdf}]]
|
||||
[["/users/{user-id}"]
|
||||
["/files/file-{number}.pdf"]]
|
||||
```
|
||||
|
||||
Route with catch-all parameter:
|
||||
|
||||
```clj
|
||||
["/public/*path" {:handler get-file}]
|
||||
["/public/*path"]
|
||||
```
|
||||
|
||||
```clj
|
||||
["/public/{*path}" {:handler get-file}]
|
||||
["/public/{*path}"]
|
||||
```
|
||||
|
||||
Nested routes:
|
||||
|
|
@ -53,9 +55,9 @@ Nested routes:
|
|||
```clj
|
||||
["/api"
|
||||
["/admin" {:middleware [::admin]}
|
||||
["" {:name ::admin}]
|
||||
["/db" {:name ::db}]]
|
||||
["/ping" {:name ::ping}]]
|
||||
["" ::admin]
|
||||
["/db" ::db]]
|
||||
["/ping" ::ping]]
|
||||
```
|
||||
|
||||
Same routes flattened:
|
||||
|
|
@ -75,31 +77,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:
|
||||
|
||||
```clj
|
||||
[["/api/:version" {...}]
|
||||
["/files/file-:number" {...}]
|
||||
["/user/:user-id/orders" {...}]]
|
||||
[["/api/:version"]
|
||||
["/files/file-:number"]
|
||||
["/user/:user-id/orders"]]
|
||||
```
|
||||
|
||||
Bracket path-parameters can start and stop anywhere in the path-string, the following character is used as a terminator.
|
||||
|
||||
```clj
|
||||
[["/api/{version}" {...}]
|
||||
["/files/{name}.{extension}" {...}]
|
||||
["/user/{user-id}/orders" {...}]]
|
||||
[["/api/{version}"]
|
||||
["/files/{name}.{extension}"]
|
||||
["/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:
|
||||
|
||||
```clj
|
||||
[["/files/file-{name}.pdf" {...}] ;; terminator \.
|
||||
["/files/file-{name}-{version}.pdf" {...}]] ;; terminator \-
|
||||
[["/files/file-{name}.pdf"] ;; terminator \.
|
||||
["/files/file-{name}-{version}.pdf"]] ;; terminator \-
|
||||
```
|
||||
|
||||
### Slash Free Routing
|
||||
|
||||
```clj
|
||||
[["broker.{customer}.{device}.{*data}" {...}]
|
||||
["events.{target}.{type}" {...}]]
|
||||
[["broker.{customer}.{device}.{*data}"]
|
||||
["events.{target}.{type}"]]
|
||||
```
|
||||
|
||||
### Generating routes
|
||||
|
|
|
|||
|
|
@ -63,6 +63,14 @@ Route names:
|
|||
; [:user/ping :user/user]
|
||||
```
|
||||
|
||||
The compiled route tree:
|
||||
|
||||
```clj
|
||||
(r/routes router)
|
||||
; [["/api/ping" {:name :user/ping} nil]
|
||||
; ["/api/user/:id" {:name :user/user} nil]]
|
||||
```
|
||||
|
||||
### Composing
|
||||
|
||||
As routes are defined as plain data, it's easy to merge multiple route trees into a single router
|
||||
|
|
|
|||
|
|
@ -12,8 +12,7 @@
|
|||
metosin/reitit-swagger-ui
|
||||
metosin/reitit-frontend
|
||||
metosin/reitit-sieppari
|
||||
metosin/reitit-pedestal
|
||||
fi.metosin/reitit-openapi]
|
||||
metosin/reitit-pedestal]
|
||||
:cljdoc.doc/tree
|
||||
[["Introduction" {:file "doc/README.md"}]
|
||||
["Basics" {}
|
||||
|
|
@ -32,7 +31,7 @@
|
|||
["Data-specs" {:file "doc/coercion/data_spec_coercion.md"}]
|
||||
["Malli" {:file "doc/coercion/malli_coercion.md"}]]
|
||||
["Ring" {}
|
||||
["Ring Router" {:file "doc/ring/ring.md"}]
|
||||
["Ring-router" {:file "doc/ring/ring.md"}]
|
||||
["Reverse-routing" {:file "doc/ring/reverse_routing.md"}]
|
||||
["Default handler" {:file "doc/ring/default_handler.md"}]
|
||||
["Slash handler" {:file "doc/ring/slash_handler.md"}]
|
||||
|
|
@ -48,7 +47,6 @@
|
|||
["Route Data Validation" {:file "doc/ring/route_data_validation.md"}]
|
||||
["Compiling Middleware" {:file "doc/ring/compiling_middleware.md"}]
|
||||
["Swagger Support" {:file "doc/ring/swagger.md"}]
|
||||
["OpenAPI Support" {:file "doc/ring/openapi.md"}]
|
||||
["RESTful form methods" {:file "doc/ring/RESTful_form_methods.md"}]]
|
||||
["HTTP" {}
|
||||
["Interceptors" {:file "doc/http/interceptors.md"}]
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# 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://clojure.atlassian.net/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://dev.clojure.org/jira/browse/CLJ-2116) out-of-the-box.
|
||||
|
||||
```clj
|
||||
(require '[reitit.coercion.spec])
|
||||
|
|
|
|||
|
|
@ -2,10 +2,6 @@
|
|||
|
||||
[Malli](https://github.com/metosin/malli) is data-driven Schema library for Clojure/Script.
|
||||
|
||||
## Default Syntax
|
||||
|
||||
By default, [Vector Syntax](https://github.com/metosin/malli#vector-syntax) is used:
|
||||
|
||||
```clj
|
||||
(require '[reitit.coercion.malli])
|
||||
(require '[reitit.coercion :as coercion])
|
||||
|
|
@ -48,20 +44,6 @@ Failing coercion:
|
|||
; => ExceptionInfo Request coercion failed...
|
||||
```
|
||||
|
||||
## Lite Syntax
|
||||
|
||||
Same using [Lite Syntax](https://github.com/metosin/malli#lite):
|
||||
|
||||
```clj
|
||||
(def router
|
||||
(r/router
|
||||
["/:company/users/:user-id" {:name ::user-view
|
||||
:coercion reitit.coercion.malli/coercion
|
||||
:parameters {:path {:company string?
|
||||
:user-id int?}}}]
|
||||
{:compile coercion/compile-request-coercers}))
|
||||
```
|
||||
|
||||
## Configuring coercion
|
||||
|
||||
Using `create` with options to create the coercion instead of `coercion`:
|
||||
|
|
@ -73,52 +55,19 @@ Using `create` with options to create the coercion instead of `coercion`:
|
|||
{:transformers {:body {:default reitit.coercion.malli/default-transformer-provider
|
||||
:formats {"application/json" reitit.coercion.malli/json-transformer-provider}}
|
||||
:string {:default reitit.coercion.malli/string-transformer-provider}
|
||||
:response {:default reitit.coercion.malli/default-transformer-provider
|
||||
:formats {"application/json" reitit.coercion.malli/json-transformer-provider}}}
|
||||
:response {:default reitit.coercion.malli/default-transformer-provider}}
|
||||
;; set of keys to include in error messages
|
||||
:error-keys #{:type :coercion :in #_:schema :value #_:errors :humanized #_:transformed}
|
||||
;; support lite syntax?
|
||||
:lite true
|
||||
:error-keys #{:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
||||
;; schema identity function (default: close all map schemas)
|
||||
:compile mu/closed-schema
|
||||
;; validate request & response
|
||||
:validate true
|
||||
;; top-level short-circuit to disable request & response coercion
|
||||
:enabled true
|
||||
;; strip-extra-keys (affects only predefined transformers)
|
||||
;; strip-extra-keys (effects only predefined transformers)
|
||||
:strip-extra-keys true
|
||||
;; 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
|
||||
;; encode-error
|
||||
:encode-error nil
|
||||
;; malli options
|
||||
: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})}}})
|
||||
```
|
||||
|
|
|
|||
|
|
@ -13,26 +13,11 @@
|
|||
./scripts/test.sh cljs
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
```bash
|
||||
clojure-lsp format
|
||||
clojure-lsp clean-ns
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
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)
|
||||
|
||||
## 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
|
||||
|
||||
We use [Break Versioning][breakver]. Remember our promise: patch-level bumps never include breaking changes!
|
||||
|
|
@ -40,20 +25,17 @@ We use [Break Versioning][breakver]. Remember our promise: patch-level bumps nev
|
|||
[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
|
||||
|
||||
```bash
|
||||
# create a release commit
|
||||
# Check that you're using Java 8! Making the release with a newer Java version
|
||||
# means that it is broken when used with Java 8.
|
||||
java -version
|
||||
|
||||
# new version
|
||||
./scripts/set-version "1.0.0"
|
||||
./scripts/lein-modules install
|
||||
|
||||
# !!! update the changelog
|
||||
# works
|
||||
lein test
|
||||
|
||||
git add -u
|
||||
git commit -m "Release 1.0.0"
|
||||
|
||||
# push the commit
|
||||
git push
|
||||
|
||||
# !!! check that tests pass on CI
|
||||
# deploy to clojars
|
||||
./scripts/lein-modules do clean, deploy clojars
|
||||
```
|
||||
|
||||
* 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.
|
||||
|
|
|
|||
|
|
@ -8,10 +8,6 @@ history events
|
|||
- Stateful wrapper for easy use of history integration
|
||||
- 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
|
||||
|
||||
`reitit.frontend` provides some useful functions wrapping core functions:
|
||||
|
|
@ -27,8 +23,7 @@ enabled.
|
|||
|
||||
`match-by-name` and `match-by-name!` with optional `path-paramers` and
|
||||
logging errors to `console.warn` instead of throwing errors to prevent
|
||||
React breaking due to errors. These can also [encode query-parameters](./coercion.md)
|
||||
using schema from match data.
|
||||
React breaking due to errors.
|
||||
|
||||
## Next
|
||||
|
||||
|
|
|
|||
|
|
@ -2,19 +2,8 @@
|
|||
|
||||
Reitit includes two browser history integrations.
|
||||
|
||||
Main functions are `navigate` and `set-query`. Navigate is used to navigate
|
||||
to named routes, and the options parameter can be used to control all
|
||||
parameters and if `pushState` or `replaceState` should be used to control
|
||||
browser history stack. The `set-query` function can be used to change
|
||||
or modify query parameters for the current route, it takes either map of
|
||||
new query params or function from old params to the new params.
|
||||
|
||||
There are also secondary functions following HTML5 History API:
|
||||
`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.
|
||||
|
||||
See [coercion notes](./coercion.md) to see how frontend route parameters
|
||||
can be decoded and encoded.
|
||||
Functions follow HTML5 History API: `push-state` to change route, `replace-state`
|
||||
to change route without leaving previous entry in browser history.
|
||||
|
||||
## Fragment router
|
||||
|
||||
|
|
@ -65,7 +54,7 @@ event handler for page change events.
|
|||
|
||||
## 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:
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,59 +0,0 @@
|
|||
# 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
|
||||
|
||||
```clj
|
||||
[metosin/reitit-interceptors "0.10.0"]
|
||||
[metosin/reitit-interceptors "0.5.13"]
|
||||
```
|
||||
|
||||
Just like the [ring default middleware](../ring/default_middleware.md), but for interceptors.
|
||||
|
||||
### Parameters handling
|
||||
* `reitit.http.interceptors.parameters/parameters-interceptor`
|
||||
* `reitit.http.interceptors.parameters/parameters-interceptor`
|
||||
|
||||
### Exception handling
|
||||
* `reitit.http.interceptors.exception/exception-interceptor`
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Reitit has also support for [interceptors](http://pedestal.io/reference/intercep
|
|||
## Reitit-http
|
||||
|
||||
```clj
|
||||
[metosin/reitit-http "0.10.0"]
|
||||
[metosin/reitit-http "0.5.13"]
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
```clj
|
||||
[metosin/reitit-pedestal "0.10.0"]
|
||||
[metosin/reitit-pedestal "0.5.13"]
|
||||
```
|
||||
|
||||
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
|
||||
; [io.pedestal/pedestal.service "0.5.5"]
|
||||
; [io.pedestal/pedestal.jetty "0.5.5"]
|
||||
; [metosin/reitit-pedestal "0.10.0"]
|
||||
; [metosin/reitit "0.10.0"]
|
||||
; [metosin/reitit-pedestal "0.5.13"]
|
||||
; [metosin/reitit "0.5.13"]
|
||||
|
||||
(require '[io.pedestal.http :as server])
|
||||
(require '[reitit.pedestal :as pedestal])
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Sieppari
|
||||
|
||||
```clj
|
||||
[metosin/reitit-sieppari "0.10.0"]
|
||||
[metosin/reitit-sieppari "0.5.13"]
|
||||
```
|
||||
|
||||
[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
|
||||
|
||||
```clj
|
||||
[metosin/reitit-interceptors "0.10.0"]
|
||||
[metosin/reitit-interceptors "0.5.13"]
|
||||
```
|
||||
|
||||
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:
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 127 KiB |
|
|
@ -114,7 +114,7 @@ A quick poke to [the fast routers in Go](https://github.com/julienschmidt/go-htt
|
|||
|
||||
### Faster!
|
||||
|
||||
By default, `reitit.ring/router`, `reitit.http/router` and `reitit.http/routing-interceptor` inject both `Match` and `Router` into the request. You can remove the injections setting options `:inject-match?` and `:inject-router?` to `false`. This saves some tens of nanos (with the hw described above).
|
||||
By default, `reitit.ring/ring-router`, `reitit.http/ring-router` and `reitit.http/routing-interceptor` inject both `Match` and `Router` into the request. You can remove the injections setting options `:inject-match?` and `:inject-router?` to `false`. This saves some tens of nanos (with the hw described above).
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring :as ring])
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# RESTful form methods
|
||||
|
||||
When designing RESTful applications you will be doing a lot of "PATCH" and "DELETE" request, but most browsers don't support methods other than "GET" and "POST" when it comes to submitting forms.
|
||||
When designing RESTful applications you will be doing a lot of "PATCH" and "DELETE" request, but most browsers don't support methods other than "GET" and "POST" when it comes to submitting forms.
|
||||
|
||||
There is a pattern to solve this (pioneered by Rails) using a hidden "_method" field in the form and swapping out the "POST" method for whatever is in that field.
|
||||
|
||||
We can do this with middleware in reitit like this:
|
||||
We can do this with middleware in reitit like this:
|
||||
```clj
|
||||
(defn- hidden-method
|
||||
[request]
|
||||
|
|
@ -18,20 +18,20 @@ We can do this with middleware in reitit like this:
|
|||
:wrap (fn [handler]
|
||||
(fn [request]
|
||||
(if-let [fm (and (= :post (:request-method request)) ;; if this is a :post request
|
||||
(hidden-method request))] ;; and there is a "_method" field
|
||||
(hidden-method request))] ;; and there is a "_method" field
|
||||
(handler (assoc request :request-method fm)) ;; replace :request-method
|
||||
(handler request))))})
|
||||
```
|
||||
|
||||
And apply the middleware like this:
|
||||
And apply the middleware like this:
|
||||
```clj
|
||||
(reitit.ring/ring-handler
|
||||
(reitit.ring/router ...)
|
||||
(reitit.ring/create-default-handler)
|
||||
{:middleware
|
||||
{:middleware
|
||||
[reitit.ring.middleware.parameters/parameters-middleware ;; needed to have :form-params in the request map
|
||||
reitit.ring.middleware.multipart/multipart-middleware ;; needed to have :multipart-params in the request map
|
||||
wrap-hidden-method]}) ;; our hidden method wrapper
|
||||
```
|
||||
(NOTE: This middleware must be placed here and not inside the route data given to `reitit.ring/handler`.
|
||||
(NOTE: This middleware must be placed here and not inside the route data given to `reitit.ring/handler`.
|
||||
This is so that our middleware is applied before reitit matches the request with a specific handler using the wrong method.)
|
||||
|
|
|
|||
|
|
@ -4,15 +4,13 @@ Basic coercion is explained in detail [in the Coercion Guide](../coercion/coerci
|
|||
|
||||
The following request parameters are currently supported:
|
||||
|
||||
| type | request source |
|
||||
|--------------|--------------------------------------------------|
|
||||
| `:query` | `:query-params` |
|
||||
| `:body` | `:body-params` |
|
||||
| `:request` | `:body-params`, allows per-content-type coercion |
|
||||
| `:form` | `:form-params` |
|
||||
| `:header` | `:header-params` |
|
||||
| `:path` | `:path-params` |
|
||||
| `:multipart` | `:multipart-params`, see [Default Middleware](default_middleware.md) |
|
||||
| type | request source |
|
||||
|-----------|------------------|
|
||||
| `:query` | `:query-params` |
|
||||
| `:body` | `:body-params` |
|
||||
| `:form` | `:form-params` |
|
||||
| `:header` | `:header-params` |
|
||||
| `:path` | `:path-params` |
|
||||
|
||||
To enable coercion, the following things need to be done:
|
||||
|
||||
|
|
@ -37,11 +35,11 @@ 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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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`.
|
||||
|
||||
Handlers can access the coerced parameters via the `:parameters` key in the request.
|
||||
Handler can access the coerced parameters can be read under `:parameters` key in the request.
|
||||
|
||||
```clj
|
||||
(require '[reitit.coercion.schema])
|
||||
|
|
@ -54,8 +52,7 @@ Handlers can access the coerced parameters via the `:parameters` key in the requ
|
|||
:parameters {:query {:x s/Int}
|
||||
:body {:y s/Int}
|
||||
:path {:z s/Int}}
|
||||
:responses {200 {:body {:total PositiveInt}}
|
||||
:default {:body {:error s/Str}}}
|
||||
:responses {200 {:body {:total PositiveInt}}}
|
||||
:handler (fn [{:keys [parameters]}]
|
||||
(let [total (+ (-> parameters :query :x)
|
||||
(-> parameters :body :y)
|
||||
|
|
@ -63,54 +60,6 @@ Handlers can access the coerced parameters via the `:parameters` key in the requ
|
|||
{:status 200
|
||||
: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
|
||||
|
||||
|
|
@ -122,7 +71,7 @@ Defining a coercion for a route data doesn't do anything, as it's just data. We
|
|||
|
||||
### Full example
|
||||
|
||||
Here is a full example for applying coercion with Reitit, Ring and Schema:
|
||||
Here's an full example for applying coercion with Reitit, Ring and Schema:
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring.coercion :as rrc])
|
||||
|
|
@ -199,56 +148,9 @@ Invalid response:
|
|||
; :in [:response :body]}}
|
||||
```
|
||||
|
||||
## Per-content-type coercion
|
||||
|
||||
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
|
||||
(def app
|
||||
(ring/ring-handler
|
||||
(ring/router
|
||||
["/api"
|
||||
["/example" {:post {:coercion reitit.coercion.schema/coercion
|
||||
:request {:content {"application/json" {:schema {:y s/Int}}
|
||||
"application/edn" {:schema {:z s/Int}}
|
||||
;; default if no content-type matches:
|
||||
:default {:schema {:yy s/Int}}}}
|
||||
:responses {200 {:content {"application/json" {:schema {:w s/Int}}
|
||||
"application/edn" {:schema {:x s/Int}}
|
||||
:default {:schema {:ww s/Int}}}}}
|
||||
:handler ...}}]]
|
||||
{:data {:muuntaja muuntaja.core/instance
|
||||
:middleware [reitit.ring.middleware.muuntaja/format-middleware
|
||||
reitit.ring.coercion/coerce-exceptions-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
|
||||
|
||||
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 into request & response coercion errors, enabling pretty-printers like [expound](https://github.com/bhb/expound) to be used:
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring :as ring])
|
||||
|
|
@ -314,7 +216,7 @@ Spec problems are exposed as is in request & response coercion errors. Pretty-pr
|
|||
|
||||
### Optimizations
|
||||
|
||||
The coercion middlewares are [compiled against a route](compiling_middleware.md). In the middleware compilation step the actual coercer implementations are constructed for the defined models. Also, the middleware doesn't mount itself if a route doesn't have `:coercion` and `:parameters` or `:responses` defined.
|
||||
The coercion middleware are [compiled against a route](compiling_middleware.md). In the middleware compilation step the actual coercer implementations are constructed for the defined models. Also, the middleware doesn't mount itself if a route doesn't have `:coercion` and `:parameters` or `:responses` defined.
|
||||
|
||||
We can query the compiled middleware chain for the routes:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Compiling Middleware
|
||||
|
||||
The [dynamic extensions](dynamic_extensions.md) are an easy way to extend the system. To enable fast lookup of route data, we can compile them into any shape (records, functions etc.), enabling fast access at request-time.
|
||||
The [dynamic extensions](dynamic_extensions.md) is a easy way to extend the system. To enable fast lookups into route data, we can compile them into any shape (records, functions etc.) we want, enabling fast access at request-time.
|
||||
|
||||
But, we can do much better. As we know the exact route that a middleware/interceptor is linked to, we can pass the (compiled) route information into the middleware at creation-time. It can do local reasoning: Extract and transform relevant data just for it and pass the optimized data into the actual request-handler via a closure - yielding much faster runtime processing. A middleware can also decide not to mount itself by returning `nil`. (E.g. Why mount a `wrap-enforce-roles` middleware for a route if there are no roles required for it?)
|
||||
But, we can do much better. As we know the exact route that middleware/interceptor is linked to, we can pass the (compiled) route information into the middleware at creation-time. It can do local reasoning: extract and transform relevant data just for it and pass the optimized data into the actual request-handler via a closure - yielding much faster runtime processing. Middleware can also decide not to mount itself by returning `nil`. Why mount a `wrap-enforce-roles` middleware for a route if there are no roles required for it?
|
||||
|
||||
To enable this we use [middleware records](data_driven_middleware.md) `:compile` key instead of the normal `:wrap`. `:compile` expects a function of `route-data router-opts => ?IntoMiddleware`.
|
||||
|
||||
To demonstrate the two approaches, below is the response coercion middleware written as normal ring middleware function and as middleware record with `:compile`.
|
||||
To demonstrate the two approaches, below are response coercion middleware written as normal ring middleware function and as middleware record with `:compile`.
|
||||
|
||||
## Normal Middleware
|
||||
|
||||
|
|
@ -27,8 +27,8 @@ To demonstrate the two approaches, below is the response coercion middleware wri
|
|||
coercion (-> match :data :coercion)
|
||||
opts (-> match :data :opts)]
|
||||
(if (and coercion responses)
|
||||
(let [coercer (response-coercer coercion responses opts)]
|
||||
(coercer request response))
|
||||
(let [coercers (response-coercers coercion responses opts)]
|
||||
(coerce-response coercers request response))
|
||||
response)))
|
||||
([request respond raise]
|
||||
(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)
|
||||
opts (-> match :data :opts)]
|
||||
(if (and coercion responses)
|
||||
(let [coercer (response-coercer coercion responses opts)]
|
||||
(handler request #(respond (coercer request %))))
|
||||
(let [coercers (response-coercers coercion responses opts)]
|
||||
(handler request #(respond (coerce-response coercers request %))))
|
||||
(handler request respond raise))))))
|
||||
```
|
||||
|
||||
|
|
@ -60,13 +60,13 @@ To demonstrate the two approaches, below is the response coercion middleware wri
|
|||
:spec ::rs/responses
|
||||
:compile (fn [{:keys [coercion responses]} opts]
|
||||
(if (and coercion responses)
|
||||
(let [coercer (coercion/response-coercer coercion responses opts)]
|
||||
(let [coercers (coercion/response-coercers coercion responses opts)]
|
||||
(fn [handler]
|
||||
(fn
|
||||
([request]
|
||||
(coercer request (handler request)))
|
||||
(coercion/coerce-response coercers request (handler request)))
|
||||
([request respond raise]
|
||||
(handler request #(respond (coercer request %)) raise)))))))})
|
||||
(handler request #(respond (coercion/coerce-response coercers request %)) raise)))))))})
|
||||
```
|
||||
|
||||
It has 50% less code, it's much easier to reason about and is much faster.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Content Negotiation
|
||||
|
||||
Wrapper for [Muuntaja](https://github.com/metosin/muuntaja) middleware for content negotiation, request decoding and response encoding. Takes explicit configuration via `:muuntaja` key in route data. Emits [swagger](swagger.md) `:produces` and `:consumes` definitions automatically based on the Muuntaja configuration.
|
||||
Wrapper for [Muuntaja](https://github.com/metosin/muuntaja) middleware for content-negotiation, request decoding and response encoding. Takes explicit configuration via `:muuntaja` key in route data. Emit's [swagger](swagger.md) `:produces` and `:consumes` definitions automatically based on the Muuntaja configuration.
|
||||
|
||||
Negotiates a request body based on `Content-Type` header and response body based on `Accept` and `Accept-Charset` headers. Publishes the negotiation results as `:muuntaja/request` and `:muuntaja/response` keys into the request.
|
||||
Negotiates a request body based on `Content-Type` header and response body based on `Accept`, `Accept-Charset` headers. Publishes the negotiation results as `:muuntaja/request` and `:muuntaja/response` keys into the request.
|
||||
|
||||
Decodes the request body into `:body-params` using the `:muuntaja/request` key in request if the `:body-params` doesn't already exist.
|
||||
|
||||
|
|
@ -84,12 +84,10 @@ Server: Jetty(9.2.21.v20170120)
|
|||
<kikka>kukka</kikka>
|
||||
```
|
||||
|
||||
You can also specify request and response schemas per content-type. See [Coercion](coercion.md) and [OpenAPI Support](openapi.md).
|
||||
|
||||
|
||||
## Changing default parameters
|
||||
|
||||
The current JSON formatter used by `reitit` already has the option to parse keys as `keyword` which is a sane default in Clojure. However, if you would like to parse all the `double` as `bigdecimal` you'd need to change an option of the [JSON formatter](https://github.com/metosin/jsonista)
|
||||
The current JSON formatter used by `reitit` already have the option to parse keys as `keyword` which is a sane default in Clojure. However, if you would like to parse all the `double` as `bigdecimal` you'd need to change an option of the [JSON formatter](https://github.com/metosin/jsonista)
|
||||
|
||||
|
||||
```clj
|
||||
|
|
@ -104,7 +102,7 @@ The current JSON formatter used by `reitit` already has the option to parse keys
|
|||
|
||||
Now you should change the `m/instance` installed in the router with the `new-muuntaja-instance`.
|
||||
|
||||
Here you can find more options for [JSON](https://cljdoc.org/d/metosin/jsonista/0.2.5/api/jsonista.core#object-mapper) and EDN.
|
||||
You can find more options for [JSON](https://cljdoc.org/d/metosin/jsonista/0.2.5/api/jsonista.core#object-mapper) and [EDN].
|
||||
|
||||
|
||||
## Adding custom encoder
|
||||
|
|
@ -127,14 +125,14 @@ The example below is from `muuntaja` explaining how to add a custom encoder to p
|
|||
|
||||
```
|
||||
|
||||
## Putting it all together
|
||||
## Adding all together
|
||||
|
||||
If you inspect `m/default-options` you'll find it's only a map. This means you can compose your new muuntaja instance with as many options as you need.
|
||||
If you inspect `m/default-options` it's only a map, therefore you can compose your new muuntaja instance with as many options as you need it.
|
||||
|
||||
```clj
|
||||
(def new-muuntaja
|
||||
(m/create
|
||||
(-> m/default-options
|
||||
(assoc-in [:formats "application/json" :decoder-opts :bigdecimals] true)
|
||||
(assoc-in [:formats "application/json" :encoder-opts :date-format] "yyyy-MM-dd"))))
|
||||
(assoc-in [:formats "application/json" :encoder-opts :data-format] "yyyy-MM-dd"))))
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,21 +1,19 @@
|
|||
# Data-driven Middleware
|
||||
|
||||
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).
|
||||
Ring [defines middleware](https://github.com/ring-clojure/ring/wiki/Concepts#middleware) as a function of type `handler & args => request => response`. It's relatively easy to understand and enables good performance. Downside is that the middleware-chain is just a opaque function, making things like debugging and composition hard. It's too easy to apply the middleware in wrong order.
|
||||
|
||||
Reitit defines middleware as data:
|
||||
|
||||
1. A middleware can be defined as first-class data entries
|
||||
2. A middleware can be mounted as a [duct-style](https://github.com/duct-framework/duct/wiki/Configuration) vector (of middlewares)
|
||||
4. A middleware can be optimized & [compiled](compiling_middleware.md) against an endpoint
|
||||
3. A middleware chain can be transformed by the router
|
||||
1. Middleware can be defined as first-class data entries
|
||||
2. Middleware can be mounted as a [duct-style](https://github.com/duct-framework/duct/wiki/Configuration) vector (of middleware)
|
||||
4. Middleware can be optimized & [compiled](compiling_middleware.md) against an endpoint
|
||||
3. Middleware chain can be transformed by the router
|
||||
|
||||
## Middleware as data
|
||||
|
||||
All values in the `:middleware` vector of route data are expanded into `reitit.middleware/Middleware` Records by using the `reitit.middleware/IntoMiddleware` Protocol. By default, functions, maps and `Middleware` records are allowed.
|
||||
All values in the `:middleware` vector in the route data are expanded into `reitit.middleware/Middleware` Records with using the `reitit.middleware/IntoMiddleware` Protocol. By default, functions, maps and `Middleware` records are allowed.
|
||||
|
||||
Records can have arbitrary keys, but the following keys have special purpose:
|
||||
Records can have arbitrary keys, but the following keys have a special purpose:
|
||||
|
||||
| key | description |
|
||||
| ---------------|-------------|
|
||||
|
|
@ -24,13 +22,13 @@ Records can have arbitrary keys, but the following keys have special purpose:
|
|||
| `:wrap` | The actual middleware function of `handler & args => request => response`
|
||||
| `:compile` | Middleware compilation function, see [compiling middleware](compiling_middleware.md).
|
||||
|
||||
Middleware Records are accessible in their raw form in the compiled route results, and thus are available for inventories, creating api-docs, etc.
|
||||
Middleware Records are accessible in their raw form in the compiled route results, thus available for inventories, creating api-docs etc.
|
||||
|
||||
For the actual request processing, the Records are unwrapped into normal functions and composed into a middleware function chain, yielding zero runtime penalty.
|
||||
|
||||
### Creating Middleware
|
||||
|
||||
The following examples produce identical middleware runtime functions.
|
||||
The following produce identical middleware runtime function.
|
||||
|
||||
### Function
|
||||
|
||||
|
|
@ -79,7 +77,7 @@ The following examples produce identical middleware runtime functions.
|
|||
:handler handler}}]])))
|
||||
```
|
||||
|
||||
All the middlewares are applied correctly:
|
||||
All the middleware are applied correctly:
|
||||
|
||||
```clj
|
||||
(app {:request-method :get, :uri "/api/ping"})
|
||||
|
|
@ -88,7 +86,7 @@ All the middlewares are applied correctly:
|
|||
|
||||
## Compiling middleware
|
||||
|
||||
Middlewares can be optimized against an endpoint using [middleware compilation](compiling_middleware.md).
|
||||
Middleware can be optimized against an endpoint using [middleware compilation](compiling_middleware.md).
|
||||
|
||||
## Ideas for the future
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Default handler
|
||||
|
||||
By default, if no routes match, `nil` is returned, which is not a valid response in Ring:
|
||||
By default, if no routes match, `nil` is returned, which is not valid response in Ring:
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring :as ring])
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# Default Middleware
|
||||
|
||||
```clj
|
||||
[metosin/reitit-middleware "0.10.0"]
|
||||
[metosin/reitit-middleware "0.5.13"]
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
* [Parameter Handling](#parameters-handling)
|
||||
* [Exception Handling](#exception-handling)
|
||||
|
|
@ -17,6 +17,8 @@ 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
|
||||
`ring.middleware.params/wrap-params`.
|
||||
|
||||
**NOTE**: 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.
|
||||
|
||||
## Exception Handling
|
||||
|
||||
See [Exception Handling with Ring](exceptions.md).
|
||||
|
|
@ -30,7 +32,7 @@ See [Content Negotiation](content_negotiation.md).
|
|||
Wrapper for [Ring Multipart Middleware](https://github.com/ring-clojure/ring/blob/master/ring-core/src/ring/middleware/multipart_params.clj). Emits swagger `:consumes` definitions automatically.
|
||||
|
||||
Expected route data:
|
||||
|
||||
|
||||
| key | description |
|
||||
| -------------|-------------|
|
||||
| `[:parameters :multipart]` | mounts only if defined for a route.
|
||||
|
|
@ -57,4 +59,4 @@ Partial sample output:
|
|||
|
||||
## Example app
|
||||
|
||||
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>.
|
||||
See an example app with the default middleware in action: https://github.com/metosin/reitit/blob/master/examples/ring-swagger/src/example/server.clj.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Dynamic Extensions
|
||||
|
||||
`ring-handler` injects the `Match` into a request and it can be extracted at runtime with `reitit.ring/get-match`. This can be used to build ad hoc extensions to the system.
|
||||
`ring-handler` injects the `Match` into a request and it can be extracted at runtime with `reitit.ring/get-match`. This can be used to build ad-hoc extensions to the system.
|
||||
|
||||
This example shows a middleware to guard routes based on user roles:
|
||||
Example middleware to guard routes based on user roles:
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring :as ring])
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# Exception Handling with Ring
|
||||
|
||||
```clj
|
||||
[metosin/reitit-middleware "0.10.0"]
|
||||
[metosin/reitit-middleware "0.5.13"]
|
||||
```
|
||||
|
||||
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 practise is a have an top-level exception handler to log and format the errors for clients.
|
||||
|
||||
```clj
|
||||
(require '[reitit.ring.middleware.exception :as exception])
|
||||
|
|
@ -36,7 +36,7 @@ A preconfigured middleware using `exception/default-handlers`. Catches:
|
|||
|
||||
### `exception/create-exception-middleware`
|
||||
|
||||
Creates the exception-middleware with custom options. Takes a map of `identifier => exception request => response` that is used to select the exception handler for the thrown/raised exception identifier. Exception identifier is either a `Keyword` or an Exception Class.
|
||||
Creates the exception-middleware with custom options. Takes a map of `identifier => exception request => response` that is used to select the exception handler for the thrown/raised exception identifier. Exception identifier is either a `Keyword` or a Exception Class.
|
||||
|
||||
The following handlers are available by default:
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ The handler is selected from the options map by exception identifier in the foll
|
|||
2) Class of exception
|
||||
3) `:type` ancestors of exception ex-data
|
||||
4) Super Classes of exception
|
||||
5) The `::default` handler
|
||||
5) The ::default handler
|
||||
|
||||
```clj
|
||||
;; type hierarchy
|
||||
|
|
@ -94,7 +94,7 @@ The handler is selected from the options map by exception identifier in the foll
|
|||
(def app
|
||||
(ring/ring-handler
|
||||
(ring/router
|
||||
["/fail" (fn [_] (throw (ex-info "fail" {:type ::failure})))]
|
||||
["/fail" (fn [_] (throw (ex-info "fail" {:type ::failue})))]
|
||||
{:data {:middleware [exception-middleware]}})))
|
||||
|
||||
(app {:request-method :get, :uri "/fail"})
|
||||
|
|
@ -102,6 +102,6 @@ The handler is selected from the options map by exception identifier in the foll
|
|||
; => {:status 500,
|
||||
; :body {:message "default"
|
||||
; :exception clojure.lang.ExceptionInfo
|
||||
; :data {:type :user/failure}
|
||||
; :data {:type :user/failue}
|
||||
; :uri "/fail"}}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
## Examples
|
||||
## Examples
|
||||
|
||||
Application using middleware defined in the Middleware Registry:
|
||||
|
||||
|
|
@ -52,20 +52,6 @@ Router creation fails fast if the registry doesn't contain the middleware:
|
|||
;| :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?
|
||||
|
||||
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`.
|
||||
|
|
|
|||
|
|
@ -1,214 +0,0 @@
|
|||
# OpenAPI Support
|
||||
|
||||
**Stability: alpha**
|
||||
|
||||
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).
|
||||
|
||||
The main example is [examples/openapi](../../examples/openapi).
|
||||
The
|
||||
[ring-malli-swagger](../../examples/ring-malli-swagger)
|
||||
and
|
||||
[ring-spec-swagger](../../examples/ring-spec-swagger)
|
||||
examples also
|
||||
have OpenAPI documentation.
|
||||
|
||||
## OpenAPI data
|
||||
|
||||
The following route data keys contribute to the generated swagger specification:
|
||||
|
||||
| key | description |
|
||||
| ---------------|-------------|
|
||||
| :openapi | map of any openapi data. Can contain keys like `:deprecated`.
|
||||
| :no-doc | optional boolean to exclude endpoint from api docs
|
||||
| :tags | optional set of string or keyword tags for an endpoint api docs
|
||||
| :summary | optional short string summary of an endpoint
|
||||
| :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:
|
||||
|
||||
| key | description |
|
||||
| --------------|-------------|
|
||||
| :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
|
||||
|
||||
|
||||
## Per-content-type coercions
|
||||
|
||||
Use `:request` coercion (instead of `:body`) to unlock
|
||||
per-content-type coercions. This also lets you specify multiple named
|
||||
examples. See [Coercion](coercion.md) for more info. See also [the
|
||||
openapi example](../../examples/openapi).
|
||||
|
||||
```clj
|
||||
["/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
|
||||
[:color :keyword]
|
||||
[:pineapple :boolean]]
|
||||
:examples {:white {:description "White pizza with pineapple"
|
||||
:value {:color :white
|
||||
: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})}}}}}}
|
||||
```
|
||||
|
||||
The special `:default` content types map to the content types supported by the Muuntaja
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
["/openapi.json"
|
||||
{:get {:handler (openapi/create-openapi-handler)
|
||||
:openapi {:info {:title "my nice api" :version "0.0.1"}}
|
||||
:no-doc true}}]
|
||||
```
|
||||
|
||||
If you need to post-process the generated spec, just wrap the handler with a custom `Middleware` or an `Interceptor`.
|
||||
|
||||
## 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. See `reitit.swagger-ui/create-swagger-ui-handle`
|
||||
|
||||
## 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,14 +5,14 @@
|
|||
Read more about the [Ring Concepts](https://github.com/ring-clojure/ring/wiki/Concepts).
|
||||
|
||||
```clj
|
||||
[metosin/reitit-ring "0.10.0"]
|
||||
[metosin/reitit-ring "0.5.13"]
|
||||
```
|
||||
|
||||
## `reitit.ring/router`
|
||||
## `reitit.ring/ring-router`
|
||||
|
||||
`reitit.ring/router` is a higher order router, which adds support for `:request-method` based routing, [handlers](https://github.com/ring-clojure/ring/wiki/Concepts#handlers) and [middleware](https://github.com/ring-clojure/ring/wiki/Concepts#middleware).
|
||||
|
||||
It accepts the following options:
|
||||
`ring-router` is a higher order router, which adds support for `:request-method` based routing, [handlers](https://github.com/ring-clojure/ring/wiki/Concepts#handlers) and [middleware](https://github.com/ring-clojure/ring/wiki/Concepts#middleware).
|
||||
|
||||
It accepts the following options:
|
||||
|
||||
| key | description |
|
||||
| ----------------------------------------|-------------|
|
||||
|
|
@ -33,7 +33,7 @@ Example router:
|
|||
["/ping" {:get handler}]))
|
||||
```
|
||||
|
||||
Match contains `:result` compiled by `reitit.ring/router`:
|
||||
Match contains `:result` compiled by the `ring-router`:
|
||||
|
||||
```clj
|
||||
(require '[reitit.core :as r])
|
||||
|
|
@ -49,11 +49,11 @@ Match contains `:result` compiled by `reitit.ring/router`:
|
|||
|
||||
## `reitit.ring/ring-handler`
|
||||
|
||||
Given a router from `reitit.ring/router`, optional default-handler & options, `ring-handler` function will return a valid ring handler supporting both synchronous and [asynchronous](https://www.booleanknot.com/blog/2016/07/15/asynchronous-ring.html) request handling. The following options are available:
|
||||
Given a `ring-router`, optional default-handler & options, `ring-handler` function will return a valid ring handler supporting both synchronous and [asynchronous](https://www.booleanknot.com/blog/2016/07/15/asynchronous-ring.html) request handling. The following options are available:
|
||||
|
||||
| key | description |
|
||||
| ------------------|-------------|
|
||||
| `:middleware` | Optional sequence of middlewares that wrap the ring-handler
|
||||
| `:middleware` | Optional sequence of middleware that wrap the ring-handler"
|
||||
| `:inject-match?` | Boolean to inject `match` into request under `:reitit.core/match` key (default true)
|
||||
| `:inject-router?` | Boolean to inject `router` into request under `:reitit.core/router` key (default true)
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ The router can be accessed via `get-router`:
|
|||
|
||||
# Request-method based routing
|
||||
|
||||
Handlers can be placed either to the top-level (all methods) or under a specific method (`:get`, `:head`, `:patch`, `:delete`, `:options`, `:post`, `:put` or `:trace`). Top-level handler is used if request-method based handler is not found.
|
||||
Handlers can be placed either to the top-level (all methods) or under a specific method (`:get`, `:head`, `:patch`, `:delete`, `:options`, `:post`, `:put` or `:trace`). Top-level handler is used if request-method based handler is not found.
|
||||
|
||||
By default, the `:options` route is generated for all paths - to enable thing like [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing).
|
||||
|
||||
|
|
@ -141,7 +141,7 @@ Name-based reverse routing:
|
|||
|
||||
# Middleware
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
1. normal ring middleware function `handler -> request -> response`
|
||||
2. vector of middleware function `[handler args*] -> request -> response` and it's arguments
|
||||
|
|
@ -194,56 +194,11 @@ Top-level middleware, applied before any routing is done:
|
|||
(def app
|
||||
(ring/ring-handler
|
||||
(ring/router
|
||||
["/api" {:middleware [[wrap :api]]}
|
||||
["/api" {:middleware [[mw :api]]}
|
||||
["/get" {:get handler}]])
|
||||
nil
|
||||
{:middleware [[wrap :top]]}))
|
||||
nil
|
||||
{:middleware [[mw :top]]}))
|
||||
|
||||
(app {:request-method :get, :uri "/api/get"})
|
||||
; {: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,16 +54,14 @@ 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.
|
||||
|
||||
| key | description |
|
||||
| --------------------|-------------|
|
||||
| :parameter | optional name of the wildcard parameter, defaults to unnamed keyword `:`
|
||||
| :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.
|
||||
| :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-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)
|
||||
| key | description |
|
||||
| -------------------|-------------|
|
||||
| :parameter | optional name of the wildcard parameter, defaults to unnamed keyword `:`
|
||||
| :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.
|
||||
| :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\"]`
|
||||
| :not-found-handler | optional handler function to use if the requested resource is missing (404 Not Found)
|
||||
|
||||
|
||||
### TODO
|
||||
|
|
|
|||
|
|
@ -1,14 +1,12 @@
|
|||
# Swagger Support
|
||||
|
||||
```
|
||||
[metosin/reitit-swagger "0.10.0"]
|
||||
[metosin/reitit-swagger "0.5.13"]
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
See also: [OpenAPI support](openapi.md).
|
||||
|
||||
To enable swagger-documentation for a Ring router:
|
||||
To enable swagger-documentation for a ring-router:
|
||||
|
||||
1. annotate your routes with swagger-data
|
||||
2. mount a swagger-handler to serve the swagger-spec
|
||||
|
|
@ -25,7 +23,6 @@ The following route data keys contribute to the generated swagger specification:
|
|||
| :tags | optional set of string or keyword tags for an endpoint api docs
|
||||
| :summary | optional short string summary of an endpoint
|
||||
| :description | optional long description of an endpoint. Supports http://spec.commonmark.org/
|
||||
| :operationId | optional string specifying the unique ID of an Operation
|
||||
|
||||
Coercion keys also contribute to the docs:
|
||||
|
||||
|
|
@ -47,10 +44,10 @@ 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.
|
||||
|
||||
```
|
||||
[metosin/reitit-swagger-ui "0.10.0"]
|
||||
[metosin/reitit-swagger-ui "0.5.13"]
|
||||
```
|
||||
|
||||
`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-hander` can be used to create a ring-handler to serve the swagger-ui. It accepts the following options:
|
||||
|
||||
| key | description |
|
||||
| -----------------|-------------|
|
||||
|
|
@ -131,7 +128,7 @@ Another way to serve the swagger-ui is using the [default handler](default_handl
|
|||
["/pong" {:post (constantly {:status 200, :body "pong"})}]]
|
||||
["/swagger.json"
|
||||
{:get {:no-doc true
|
||||
:handler (swagger/create-swagger-handler)}}]])
|
||||
:handler (swagger/create-swagger-handler)}}]])
|
||||
(swagger-ui/create-swagger-ui-handler {:path "/api-docs"})))
|
||||
```
|
||||
|
||||
|
|
@ -145,7 +142,7 @@ Another way to serve the swagger-ui is using the [default handler](default_handl
|
|||
* missed routes are handled by `create-default-handler`
|
||||
* served via [ring-jetty](https://github.com/ring-clojure/ring/tree/master/ring-jetty-adapter)
|
||||
|
||||
Whole example project is in [`/examples/ring-spec-swagger`](https://github.com/metosin/reitit/tree/master/examples/ring-spec-swagger).
|
||||
Whole example project is in [`/examples/ring-swagger`](https://github.com/metosin/reitit/tree/master/examples/ring-swagger).
|
||||
|
||||
```clj
|
||||
(ns example.server
|
||||
|
|
@ -286,18 +283,7 @@ Example with:
|
|||
; ("/common/ping" "/one/ping" "/two/ping" "/two/deep/ping")
|
||||
```
|
||||
|
||||
## 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
|
||||
### TODO
|
||||
|
||||
* ClojureScript
|
||||
* example for [Macchiato](https://github.com/macchiato-framework)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Transforming the Middleware Chain
|
||||
|
||||
There is an extra option in the Ring router (actually, in the underlying middleware-router): `:reitit.middleware/transform` to transform the middleware chain per endpoint. Value should be a function or a vector of functions that get a vector of compiled middleware and should return a new vector of middleware.
|
||||
There is an extra option in ring-router (actually, in the underlying middleware-router): `:reitit.middleware/transform` to transform the middleware chain per endpoint. Value should be a function or a vector of functions that get a vector of compiled middleware and should return a new vector of middleware.
|
||||
|
||||
## Example Application
|
||||
|
||||
|
|
@ -59,7 +59,7 @@ There is an extra option in the Ring router (actually, in the underlying middlew
|
|||
### Printing Request Diffs
|
||||
|
||||
```clj
|
||||
[metosin/reitit-middleware "0.10.0"]
|
||||
[metosin/reitit-middleware "0.5.13"]
|
||||
```
|
||||
|
||||
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:
|
||||
|
|
@ -71,3 +71,4 @@ Using `reitit.ring.middleware.dev/print-request-diffs` transformation, the reque
|
|||
Sample output:
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,53 +0,0 @@
|
|||
# Examples
|
||||
|
||||
## buddy-auth
|
||||
## frontend-auth
|
||||
## frontend-controllers
|
||||
## frontend-links
|
||||
## frontend-prompt
|
||||
## frontend-re-frame
|
||||
## frontend
|
||||
|
||||
Frontend example with clojure.spec coercion.
|
||||
|
||||
## frontend-malli
|
||||
|
||||
Frontend example with Malli coercion.
|
||||
|
||||
## http-swagger
|
||||
|
||||
Coercion with Spec and Swagger generation.
|
||||
|
||||
Same as ring-spec-swagger?
|
||||
|
||||
Async examples as extra.
|
||||
|
||||
## http
|
||||
|
||||
Async example.
|
||||
|
||||
## just-coercion-with-ring
|
||||
|
||||
Bad name.
|
||||
|
||||
Coercion example for spec, data-spec, Schema.
|
||||
No Swagger generation or Malli!
|
||||
|
||||
Same as ring-example?
|
||||
|
||||
## pedestal-swagger
|
||||
## pedestal
|
||||
## ring-example
|
||||
|
||||
Coercion example for spec, data-spec, Schema.
|
||||
No Swagger generation or Malli!
|
||||
|
||||
## ring-integrant
|
||||
|
||||
## ring-malli-swagger
|
||||
|
||||
Coercion with Malli and Swagger generation.
|
||||
|
||||
## ring-spec-swagger
|
||||
|
||||
Coercion with Spec and Swagger generation.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
(defproject buddy-auth "0.1.0-SNAPSHOT"
|
||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Buddy Auth App"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
:dependencies [[org.clojure/clojure "1.10.1"]
|
||||
[ring/ring-jetty-adapter "1.8.1"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[buddy "2.0.0"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,25 +1,23 @@
|
|||
(defproject frontend-auth "0.1.0-SNAPSHOT"
|
||||
(defproject frontend "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.11.2"]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring-server "0.5.0"]
|
||||
[reagent "1.2.0"]
|
||||
[ring "1.12.1"]
|
||||
[reagent "0.8.1"]
|
||||
[ring "1.7.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.11.132"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit-schema "0.10.0"]
|
||||
[metosin/reitit-frontend "0.10.0"]
|
||||
[cljsjs/react "17.0.2-0"]
|
||||
[cljsjs/react-dom "17.0.2-0"]
|
||||
[org.clojure/clojurescript "1.10.439"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[metosin/reitit-schema "0.5.13"]
|
||||
[metosin/reitit-frontend "0.5.13"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.14"]]
|
||||
|
||||
:plugins [[lein-cljsbuild "1.1.8"]
|
||||
[lein-figwheel "0.5.20"]]
|
||||
:plugins [[lein-cljsbuild "1.1.7"]
|
||||
[lein-figwheel "0.5.18"]]
|
||||
|
||||
:source-paths []
|
||||
:resource-paths ["resources" "target/cljsbuild"]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
(ns frontend.core
|
||||
(:require [reagent.core :as r]
|
||||
[reagent.dom :as rd]
|
||||
[reitit.frontend :as rf]
|
||||
[reitit.frontend.easy :as rfe]
|
||||
[reitit.frontend.controllers :as rfc]
|
||||
|
|
@ -148,6 +147,6 @@
|
|||
(assoc state :match (assoc new-match :controllers (rfc/apply-controllers (:controllers (:match state)) new-match)))
|
||||
(assoc state :match new-match))))))
|
||||
{:use-fragment true})
|
||||
(rd/render [main-view] (.getElementById js/document "app")))
|
||||
(r/render [main-view] (.getElementById js/document "app")))
|
||||
|
||||
(init!)
|
||||
|
|
|
|||
|
|
@ -1,25 +1,23 @@
|
|||
(defproject frontend-controllers "0.1.0-SNAPSHOT"
|
||||
(defproject frontend "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.11.2"]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring-server "0.5.0"]
|
||||
[reagent "1.2.0"]
|
||||
[ring "1.12.1"]
|
||||
[reagent "0.8.1"]
|
||||
[ring "1.7.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.11.132"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit-schema "0.10.0"]
|
||||
[metosin/reitit-frontend "0.10.0"]
|
||||
[cljsjs/react "17.0.2-0"]
|
||||
[cljsjs/react-dom "17.0.2-0"]
|
||||
[org.clojure/clojurescript "1.10.439"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[metosin/reitit-schema "0.5.13"]
|
||||
[metosin/reitit-frontend "0.5.13"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.14"]]
|
||||
|
||||
:plugins [[lein-cljsbuild "1.1.8"]
|
||||
[lein-figwheel "0.5.20"]]
|
||||
:plugins [[lein-cljsbuild "1.1.7"]
|
||||
[lein-figwheel "0.5.18"]]
|
||||
|
||||
:source-paths []
|
||||
:resource-paths ["resources" "target/cljsbuild"]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
(ns frontend.core
|
||||
(:require [reagent.core :as r]
|
||||
[reagent.dom :as rd]
|
||||
[reitit.frontend :as rf]
|
||||
[reitit.frontend.easy :as rfe]
|
||||
[reitit.frontend.controllers :as rfc]
|
||||
|
|
@ -19,18 +18,11 @@
|
|||
[:div
|
||||
[:ul
|
||||
[:li [:a {:href (rfe/href ::item {:id 1})} "Item 1"]]
|
||||
[:li [:a {:href (rfe/href ::item {:id 2} {:foo "bar"} "zzz")} "Item 2"]]]
|
||||
(when id
|
||||
[:li [:a {:href (rfe/href ::item {:id 2} {:foo "bar"})} "Item 2"]]]
|
||||
(if id
|
||||
[:h2 "Selected item " id])
|
||||
[:p "Query params: " [:pre (pr-str query)]]
|
||||
[:ul
|
||||
[:li [:a {:on-click #(rfe/set-query {:a 1})} "set a=1"]]
|
||||
[:li [:a {:on-click #(rfe/set-query {:a 2} {:replace true})} "set a=2 and replaceState"]]
|
||||
[:li [:a {:on-click (fn [_] (rfe/set-query #(assoc % :foo "zzz")))} "add foo=zzz"]]]
|
||||
[:button
|
||||
{:on-click #(rfe/navigate ::item {:path-params {:id 3}
|
||||
:query-params {:foo "aaa"}})}
|
||||
"Navigate example, go to item 3"]]))
|
||||
(if (:foo query)
|
||||
[:p "Optional foo query param: " (:foo query)])]))
|
||||
|
||||
(defonce match (r/atom nil))
|
||||
|
||||
|
|
@ -39,8 +31,9 @@
|
|||
[:ul
|
||||
[:li [:a {:href (rfe/href ::frontpage)} "Frontpage"]]
|
||||
[:li
|
||||
[:a {:href (rfe/href ::item-list)} "Item list"]]]
|
||||
(when @match
|
||||
[:a {:href (rfe/href ::item-list)} "Item list"]
|
||||
]]
|
||||
(if @match
|
||||
(let [view (:view (:data @match))]
|
||||
[view @match]))
|
||||
[:pre (with-out-str (fedn/pprint @match))]])
|
||||
|
|
@ -70,8 +63,7 @@
|
|||
["/:id"
|
||||
{:name ::item
|
||||
:parameters {:path {:id s/Int}
|
||||
:query {(s/optional-key :a) s/Int
|
||||
(s/optional-key :foo) s/Keyword}}
|
||||
:query {(s/optional-key :foo) s/Keyword}}
|
||||
:controllers [{:parameters {:path [:id]}
|
||||
:start (fn [{:keys [path]}]
|
||||
(js/console.log "start" "item controller" (:id path)))
|
||||
|
|
@ -89,6 +81,6 @@
|
|||
(if new-match
|
||||
(assoc new-match :controllers (rfc/apply-controllers (:controllers old-match) new-match))))))
|
||||
{:use-fragment true})
|
||||
(rd/render [current-page] (.getElementById js/document "app")))
|
||||
(r/render [current-page] (.getElementById js/document "app")))
|
||||
|
||||
(init!)
|
||||
|
|
|
|||
|
|
@ -1,26 +1,24 @@
|
|||
(defproject frontend-links "0.1.0-SNAPSHOT"
|
||||
(defproject frontend "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.11.2"]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring-server "0.5.0"]
|
||||
[reagent "1.2.0"]
|
||||
[ring "1.12.1"]
|
||||
[reagent "0.8.1"]
|
||||
[ring "1.7.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.10.520"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit-spec "0.10.0"]
|
||||
[metosin/reitit-frontend "0.10.0"]
|
||||
[cljsjs/react "17.0.2-0"]
|
||||
[cljsjs/react-dom "17.0.2-0"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[metosin/reitit-spec "0.5.13"]
|
||||
[metosin/reitit-frontend "0.5.13"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.14"]]
|
||||
|
||||
: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]}
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
(:require [clojure.string :as string]
|
||||
[fipp.edn :as fedn]
|
||||
[reagent.core :as r]
|
||||
[reagent.dom :as rd]
|
||||
[reitit.coercion.spec :as rss]
|
||||
[reitit.frontend :as rf]
|
||||
[reitit.frontend.easy :as rfe]
|
||||
|
|
@ -138,7 +137,7 @@
|
|||
(fn [m] (reset! current-match m))
|
||||
;; set to false to enable HistoryAPI
|
||||
{:use-fragment true})
|
||||
(rd/render [current-page] (.getElementById js/document "app")))
|
||||
(r/render [current-page] (.getElementById js/document "app")))
|
||||
|
||||
(init!)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
# reitit-frontend example
|
||||
|
||||
## Usage
|
||||
|
||||
```clj
|
||||
> lein figwheel
|
||||
```
|
||||
|
||||
Go with browser to http://localhost:3449
|
||||
|
||||
## License
|
||||
|
||||
Copyright © Metosin Oy and collaborators
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../modules/reitit-core
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../modules/reitit-frontend
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../modules/reitit-schema
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
(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})
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Reitit frontend example</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script src="/js/app.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
(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))
|
||||
|
|
@ -1,84 +0,0 @@
|
|||
(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,27 +1,24 @@
|
|||
(defproject frontend-prompt "0.1.0-SNAPSHOT"
|
||||
(defproject frontend "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.11.2"]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring-server "0.5.0"]
|
||||
[reagent "1.2.0"]
|
||||
[ring "1.12.1"]
|
||||
[reagent "0.8.1"]
|
||||
[ring "1.7.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.11.132"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit-spec "0.10.0"]
|
||||
[metosin/reitit-frontend "0.10.0"]
|
||||
[cljsjs/react "17.0.2-0"]
|
||||
[cljsjs/react-dom "17.0.2-0"]
|
||||
[org.clojure/clojurescript "1.10.520"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[metosin/reitit-spec "0.5.13"]
|
||||
[metosin/reitit-frontend "0.5.13"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.23"]]
|
||||
|
||||
:plugins [[lein-cljsbuild "1.1.8"]
|
||||
[lein-figwheel "0.5.20"]
|
||||
[cider/cider-nrepl "0.47.1"]]
|
||||
[fipp "0.6.14"]]
|
||||
|
||||
: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]}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
(ns frontend.core
|
||||
(:require [fipp.edn :as fedn]
|
||||
[reagent.core :as r]
|
||||
[reagent.dom :as rd]
|
||||
[reitit.coercion.spec :as rss]
|
||||
[reitit.frontend :as rf]
|
||||
[reitit.frontend.easy :as rfe]))
|
||||
|
|
@ -64,6 +63,6 @@
|
|||
on-navigate
|
||||
;; set to false to enable HistoryAPI
|
||||
{:use-fragment true})
|
||||
(rd/render [current-page] (.getElementById js/document "app")))
|
||||
(r/render [current-page] (.getElementById js/document "app")))
|
||||
|
||||
(init!)
|
||||
|
|
|
|||
|
|
@ -1,15 +1,13 @@
|
|||
(defproject frontend-re-frame "0.1.0-SNAPSHOT"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[org.clojure/clojurescript "1.11.132"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[reagent "1.2.0"]
|
||||
[re-frame "0.10.6"]
|
||||
[cljsjs/react "17.0.2-0"]
|
||||
[cljsjs/react-dom "17.0.2-0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[org.clojure/clojurescript "1.10.520"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[reagent "0.8.1"]
|
||||
[re-frame "0.10.6"]]
|
||||
|
||||
: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]}
|
||||
:min-lein-version "2.5.3"
|
||||
|
|
|
|||
|
|
@ -1,20 +1,12 @@
|
|||
(ns frontend-re-frame.core
|
||||
(:require [re-frame.core :as re-frame]
|
||||
[reagent.dom :as rd]
|
||||
[reagent.core :as reagent]
|
||||
[reitit.core :as r]
|
||||
[reitit.coercion.spec :as rss]
|
||||
[reitit.frontend :as rf]
|
||||
[reitit.frontend.controllers :as rfc]
|
||||
[reitit.frontend.easy :as rfe]))
|
||||
|
||||
;;; Effects ;;;
|
||||
|
||||
;; Triggering navigation from events.
|
||||
|
||||
(re-frame/reg-fx :push-state
|
||||
(fn [route]
|
||||
(apply rfe/push-state route)))
|
||||
|
||||
;;; Events ;;;
|
||||
|
||||
(re-frame/reg-event-db ::initialize-db
|
||||
|
|
@ -24,7 +16,7 @@
|
|||
{:current-route nil})))
|
||||
|
||||
(re-frame/reg-event-fx ::push-state
|
||||
(fn [_ [_ & route]]
|
||||
(fn [db [_ & route]]
|
||||
{:push-state route}))
|
||||
|
||||
(re-frame/reg-event-db ::navigated
|
||||
|
|
@ -57,6 +49,14 @@
|
|||
[:div
|
||||
[:h1 "This is sub-page 2"]])
|
||||
|
||||
;;; Effects ;;;
|
||||
|
||||
;; Triggering navigation from events.
|
||||
|
||||
(re-frame/reg-fx :push-state
|
||||
(fn [route]
|
||||
(apply rfe/push-state route)))
|
||||
|
||||
;;; Routes ;;;
|
||||
|
||||
(defn href
|
||||
|
|
@ -143,7 +143,7 @@
|
|||
(re-frame/dispatch-sync [::initialize-db])
|
||||
(dev-setup)
|
||||
(init-routes!) ;; Reset routes on figwheel reload
|
||||
(rd/render [router-component {:router router}]
|
||||
(reagent/render [router-component {:router router}]
|
||||
(.getElementById js/document "app")))
|
||||
|
||||
(init)
|
||||
|
|
|
|||
|
|
@ -4,17 +4,15 @@
|
|||
:license {:name "Eclipse Public License"
|
||||
:url "http://www.eclipse.org/legal/epl-v10.html"}
|
||||
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
:dependencies [[org.clojure/clojure "1.10.1"]
|
||||
[ring-server "0.5.0"]
|
||||
[reagent "1.2.0"]
|
||||
[ring "1.12.1"]
|
||||
[reagent "0.10.0"]
|
||||
[ring "1.8.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.11.132"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/reitit-spec "0.10.0"]
|
||||
[metosin/reitit-frontend "0.10.0"]
|
||||
[cljsjs/react "17.0.2-0"]
|
||||
[cljsjs/react-dom "17.0.2-0"]
|
||||
[org.clojure/clojurescript "1.10.773"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[metosin/reitit-spec "0.5.13"]
|
||||
[metosin/reitit-frontend "0.5.13"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.23"]]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
(ns frontend.core
|
||||
(:require [reagent.core :as r]
|
||||
[reagent.dom :as rd]
|
||||
[reitit.frontend :as rf]
|
||||
[reitit.frontend.easy :as rfe]
|
||||
[reitit.coercion.spec :as rss]
|
||||
|
|
@ -78,6 +77,6 @@
|
|||
(fn [m] (reset! match m))
|
||||
;; set to false to enable HistoryAPI
|
||||
{:use-fragment true})
|
||||
(rd/render [current-page] (.getElementById js/document "app")))
|
||||
(r/render [current-page] (.getElementById js/document "app")))
|
||||
|
||||
(init!)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Http with Swagger/OpenAPI example
|
||||
# Http with Swagger example
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -7,10 +7,6 @@
|
|||
(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/):
|
||||
|
||||
```bash
|
||||
|
|
@ -24,4 +20,4 @@ http GET :3000/async results==1 seed==reitit
|
|||
|
||||
## License
|
||||
|
||||
Copyright © 2018-2023 Metosin Oy
|
||||
Copyright © 2018 Metosin Oy
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
(defproject http-swagger "0.1.0-SNAPSHOT"
|
||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Http App with Swagger"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[aleph "0.7.1"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/ring-swagger-ui "5.9.0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[aleph "0.4.7-alpha5"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@
|
|||
[reitit.coercion.spec]
|
||||
[reitit.swagger :as swagger]
|
||||
[reitit.swagger-ui :as swagger-ui]
|
||||
[reitit.openapi :as openapi]
|
||||
[reitit.http.coercion :as coercion]
|
||||
[reitit.dev.pretty :as pretty]
|
||||
[reitit.interceptor.sieppari :as sieppari]
|
||||
|
|
@ -39,150 +38,113 @@
|
|||
|
||||
(def app
|
||||
(http/ring-handler
|
||||
(http/router
|
||||
[["/swagger.json"
|
||||
{:get {:no-doc true
|
||||
:swagger {:info {:title "my-api"
|
||||
:description "swagger-docs with reitit-http"
|
||||
:version "0.0.1"}
|
||||
;; used in /secure APIs below
|
||||
:securityDefinitions {"auth" {:type :apiKey
|
||||
:in :header
|
||||
:name "Example-Api-Key"}}}
|
||||
: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"}
|
||||
;; used in /secure APIs below
|
||||
:components {:securitySchemes {"auth" {:type :apiKey
|
||||
:in :header
|
||||
:name "Example-Api-Key"}}}}
|
||||
:handler (openapi/create-openapi-handler)}}]
|
||||
(http/router
|
||||
[["/swagger.json"
|
||||
{:get {:no-doc true
|
||||
:swagger {:info {:title "my-api"
|
||||
:description "with reitit-http"}}
|
||||
:handler (swagger/create-swagger-handler)}}]
|
||||
|
||||
["/files"
|
||||
{:tags #{"files"}}
|
||||
["/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)}})}}]
|
||||
["/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"]}
|
||||
:responses {200 {:description "an image"
|
||||
:content {"image/png" {:schema any?}}}}
|
||||
:handler (fn [_]
|
||||
{:status 200
|
||||
:headers {"Content-Type" "image/png"}
|
||||
:body (io/input-stream
|
||||
(io/resource "reitit.png"))})}}]]
|
||||
|
||||
["/async"
|
||||
{:get {:tags #{"async"}
|
||||
:summary "fetches random users asynchronously over the internet"
|
||||
:parameters {:query (s/keys :req-un [::results] :opt-un [::seed])}
|
||||
:responses {200 {:body any?}}
|
||||
:handler (fn [{{{:keys [seed results]} :query} :parameters}]
|
||||
(d/chain
|
||||
(aleph/get
|
||||
"https://randomuser.me/api/"
|
||||
{:query-params {:seed seed, :results results}})
|
||||
:body
|
||||
(partial m/decode "application/json")
|
||||
:results
|
||||
(fn [results]
|
||||
["/download"
|
||||
{:get {:summary "downloads a file"
|
||||
:swagger {:produces ["image/png"]}
|
||||
:handler (fn [_]
|
||||
{:status 200
|
||||
:body results})))}}]
|
||||
:headers {"Content-Type" "image/png"}
|
||||
:body (io/input-stream
|
||||
(io/resource "reitit.png"))})}}]]
|
||||
|
||||
["/math"
|
||||
{:tags #{"math"}}
|
||||
["/async"
|
||||
{:get {:swagger {:tags ["async"]}
|
||||
:summary "fetches random users asynchronously over the internet"
|
||||
:parameters {:query (s/keys :req-un [::results] :opt-un [::seed])}
|
||||
:responses {200 {:body any?}}
|
||||
:handler (fn [{{{:keys [seed results]} :query} :parameters}]
|
||||
(d/chain
|
||||
(aleph/get
|
||||
"https://randomuser.me/api/"
|
||||
{:query-params {:seed seed, :results results}})
|
||||
:body
|
||||
(partial m/decode "application/json")
|
||||
:results
|
||||
(fn [results]
|
||||
{:status 200
|
||||
:body results})))}}]
|
||||
|
||||
["/plus"
|
||||
{:get {:summary "plus with data-spec query parameters"
|
||||
:parameters {:query {:x int?, :y int?}}
|
||||
:responses {200 {:body {:total pos-int?}}}
|
||||
:handler (fn [{{{:keys [x y]} :query} :parameters}]
|
||||
{:status 200
|
||||
:body {:total (+ x y)}})}
|
||||
:post {:summary "plus with data-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)}})}}]
|
||||
["/math"
|
||||
{:swagger {:tags ["math"]}}
|
||||
|
||||
["/minus"
|
||||
{:get {:summary "minus with clojure.spec query parameters"
|
||||
:parameters {:query (s/keys :req-un [::x ::y])}
|
||||
:responses {200 {:body (s/keys :req-un [::total])}}
|
||||
:handler (fn [{{{:keys [x y]} :query} :parameters}]
|
||||
{:status 200
|
||||
:body {:total (- x y)}})}
|
||||
:post {:summary "minus with clojure.spec body parameters"
|
||||
:parameters {:body (s/keys :req-un [::x ::y])}
|
||||
:responses {200 {:body (s/keys :req-un [::total])}}
|
||||
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
||||
{:status 200
|
||||
:body {:total (- x y)}})}}]]
|
||||
["/secure"
|
||||
{:tags #{"secure"}
|
||||
:openapi {:security [{"auth" []}]}
|
||||
:swagger {:security [{"auth" []}]}}
|
||||
["/get"
|
||||
{:get {:summary "endpoint authenticated with a header"
|
||||
:responses {200 {:body {:secret string?}}
|
||||
401 {:body {:error string?}}}
|
||||
:handler (fn [request]
|
||||
;; In a real app authentication would be handled by middleware
|
||||
(if (= "secret" (get-in request [:headers "example-api-key"]))
|
||||
["/plus"
|
||||
{:get {:summary "plus with data-spec query parameters"
|
||||
:parameters {:query {:x int?, :y int?}}
|
||||
:responses {200 {:body {:total pos-int?}}}
|
||||
:handler (fn [{{{:keys [x y]} :query} :parameters}]
|
||||
{:status 200
|
||||
:body {:secret "I am a marmot"}}
|
||||
{:status 401
|
||||
:body {:error "unauthorized"}}))}}]]]
|
||||
:body {:total (+ x y)}})}
|
||||
:post {:summary "plus with data-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.interceptor/transform dev/print-context-diffs ;; pretty context 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
|
||||
:interceptors [;; swagger feature
|
||||
swagger/swagger-feature
|
||||
;; openapi feature
|
||||
openapi/openapi-feature
|
||||
;; query-params & form-params
|
||||
(parameters/parameters-interceptor)
|
||||
;; content-negotiation
|
||||
(muuntaja/format-negotiate-interceptor)
|
||||
;; encoding response body
|
||||
(muuntaja/format-response-interceptor)
|
||||
;; exception handling
|
||||
(exception/exception-interceptor)
|
||||
;; decoding request body
|
||||
(muuntaja/format-request-interceptor)
|
||||
;; coercing response bodys
|
||||
(coercion/coerce-response-interceptor)
|
||||
;; coercing request parameters
|
||||
(coercion/coerce-request-interceptor)
|
||||
;; multipart
|
||||
(multipart/multipart-interceptor)]}})
|
||||
(ring/routes
|
||||
(swagger-ui/create-swagger-ui-handler
|
||||
{:path "/"
|
||||
:config {:validatorUrl nil
|
||||
:urls [{:name "swagger", :url "swagger.json"}
|
||||
{:name "openapi", :url "openapi.json"}]
|
||||
:urls.primaryName "openapi"
|
||||
:operationsSorter "alpha"}})
|
||||
(ring/create-default-handler))
|
||||
{:executor sieppari/executor}))
|
||||
["/minus"
|
||||
{:get {:summary "minus with clojure.spec query parameters"
|
||||
:parameters {:query (s/keys :req-un [::x ::y])}
|
||||
:responses {200 {:body (s/keys :req-un [::total])}}
|
||||
:handler (fn [{{{:keys [x y]} :query} :parameters}]
|
||||
{:status 200
|
||||
:body {:total (- x y)}})}
|
||||
:post {:summary "minus with clojure.spec body parameters"
|
||||
:parameters {:body (s/keys :req-un [::x ::y])}
|
||||
:responses {200 {:body (s/keys :req-un [::total])}}
|
||||
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
||||
{:status 200
|
||||
:body {:total (- x y)}})}}]]]
|
||||
|
||||
{;:reitit.interceptor/transform dev/print-context-diffs ;; pretty context 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
|
||||
:interceptors [;; swagger feature
|
||||
swagger/swagger-feature
|
||||
;; query-params & form-params
|
||||
(parameters/parameters-interceptor)
|
||||
;; content-negotiation
|
||||
(muuntaja/format-negotiate-interceptor)
|
||||
;; encoding response body
|
||||
(muuntaja/format-response-interceptor)
|
||||
;; exception handling
|
||||
(exception/exception-interceptor)
|
||||
;; decoding request body
|
||||
(muuntaja/format-request-interceptor)
|
||||
;; coercing response bodys
|
||||
(coercion/coerce-response-interceptor)
|
||||
;; coercing request parameters
|
||||
(coercion/coerce-request-interceptor)
|
||||
;; multipart
|
||||
(multipart/multipart-interceptor)]}})
|
||||
(ring/routes
|
||||
(swagger-ui/create-swagger-ui-handler
|
||||
{:path "/"
|
||||
:config {:validatorUrl nil
|
||||
:operationsSorter "alpha"}})
|
||||
(ring/create-default-handler))
|
||||
{:executor sieppari/executor}))
|
||||
|
||||
(defn start []
|
||||
(jetty/run-jetty #'app {:port 3000, :join? false, :async true})
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
(defproject http "0.1.0-SNAPSHOT"
|
||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Ring App with Swagger"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[org.clojure/core.async "1.6.681"]
|
||||
[funcool/promesa "11.0.678"]
|
||||
[manifold "0.4.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[org.clojure/core.async "0.4.490"]
|
||||
[funcool/promesa "1.9.0"]
|
||||
[manifold "0.1.8"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
(defproject just-coercion-with-ring "0.1.0-SNAPSHOT"
|
||||
:description "Reitit coercion with vanilla ring"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]])
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[metosin/reitit "0.5.13"]])
|
||||
|
|
|
|||
|
|
@ -1,18 +0,0 @@
|
|||
# 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
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 137 KiB |
|
|
@ -1,10 +0,0 @@
|
|||
(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"]]}})
|
||||
|
|
@ -1,227 +0,0 @@
|
|||
(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))
|
||||
11
examples/pedestal-malli-swagger/.gitignore
vendored
11
examples/pedestal-malli-swagger/.gitignore
vendored
|
|
@ -1,11 +0,0 @@
|
|||
/target
|
||||
/classes
|
||||
/checkouts
|
||||
pom.xml
|
||||
pom.xml.asc
|
||||
*.jar
|
||||
*.class
|
||||
/.lein-*
|
||||
/.nrepl-port
|
||||
.hgignore
|
||||
.hg/
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
(defproject pedestal-malli-swagger-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit-http with pedestal"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[io.pedestal/pedestal.service "0.6.3"]
|
||||
[io.pedestal/pedestal.jetty "0.6.3"]
|
||||
[metosin/reitit-malli "0.10.0"]
|
||||
[metosin/reitit-pedestal "0.10.0"]
|
||||
[metosin/reitit "0.10.0"]]
|
||||
:repl-options {:init-ns server})
|
||||
|
|
@ -1,164 +0,0 @@
|
|||
(ns server
|
||||
(:require [clojure.java.io :as io]
|
||||
[io.pedestal.http.route]
|
||||
[reitit.interceptor]
|
||||
[reitit.dev.pretty :as pretty]
|
||||
[reitit.coercion.malli]
|
||||
[io.pedestal.http]
|
||||
[reitit.ring]
|
||||
[reitit.ring.malli]
|
||||
[reitit.http]
|
||||
[reitit.pedestal]
|
||||
[reitit.swagger :as swagger]
|
||||
[reitit.swagger-ui :as swagger-ui]
|
||||
[reitit.http.coercion :as coercion]
|
||||
[reitit.http.interceptors.parameters :as parameters]
|
||||
[reitit.http.interceptors.muuntaja :as muuntaja]
|
||||
[reitit.http.interceptors.multipart :as multipart]
|
||||
[muuntaja.core]
|
||||
[malli.util :as mu]))
|
||||
|
||||
(defn reitit-routes
|
||||
[_config]
|
||||
[["/swagger.json" {:get {:no-doc true
|
||||
:swagger {:info {:title "my-api"
|
||||
:description "with [malli](https://github.com/metosin/malli) and reitit-ring"}
|
||||
:tags [{:name "files",
|
||||
:description "file api"}
|
||||
{:name "math",
|
||||
:description "math api"}]}
|
||||
:handler (swagger/create-swagger-handler)}}]
|
||||
["/files" {:swagger {:tags ["files"]}}
|
||||
["/upload"
|
||||
{:post {:summary "upload a file"
|
||||
:parameters {:multipart [:map [:file reitit.ring.malli/temp-file-part]]}
|
||||
:responses {200 {:body [:map
|
||||
[:name string?]
|
||||
[:size int?]]}}
|
||||
:handler (fn [{{{{:keys [filename
|
||||
size]} :file}
|
||||
:multipart}
|
||||
:parameters}]
|
||||
{:status 200
|
||||
:body {:name filename
|
||||
:size size}})}}]
|
||||
["/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 malli query parameters"
|
||||
:parameters {:query [:map
|
||||
[:x
|
||||
{:title "X parameter"
|
||||
:description "Description for X parameter"
|
||||
:json-schema/default 42}
|
||||
int?]
|
||||
[:y int?]]}
|
||||
:responses {200 {:body [:map [:total int?]]}}
|
||||
:handler (fn [{{{:keys [x
|
||||
y]}
|
||||
:query}
|
||||
:parameters}]
|
||||
{:status 200
|
||||
:body {:total (+ x y)}})}
|
||||
:post {:summary "plus with malli body parameters"
|
||||
:parameters {:body [:map
|
||||
[:x
|
||||
{:title "X parameter"
|
||||
:description "Description for X parameter"
|
||||
:json-schema/default 42}
|
||||
int?]
|
||||
[:y int?]]}
|
||||
:responses {200 {:body [:map [:total int?]]}}
|
||||
:handler (fn [{{{:keys [x
|
||||
y]}
|
||||
:body}
|
||||
:parameters}]
|
||||
{:status 200
|
||||
:body {:total (+ x y)}})}}]]])
|
||||
|
||||
(defn reitit-ring-routes
|
||||
[_config]
|
||||
[(swagger-ui/create-swagger-ui-handler
|
||||
{:path "/"
|
||||
:config {:validatorUrl nil
|
||||
:operationsSorter "alpha"}})
|
||||
(reitit.ring/create-resource-handler)
|
||||
(reitit.ring/create-default-handler)])
|
||||
|
||||
|
||||
(defn reitit-router-config
|
||||
[_config]
|
||||
{:exception pretty/exception
|
||||
:data {:coercion (reitit.coercion.malli/create
|
||||
{:error-keys #{:coercion
|
||||
:in
|
||||
:schema
|
||||
:value
|
||||
:errors
|
||||
:humanized}
|
||||
:compile mu/closed-schema
|
||||
:strip-extra-keys true
|
||||
:default-values true
|
||||
:options nil})
|
||||
:muuntaja muuntaja.core/instance
|
||||
:interceptors [swagger/swagger-feature
|
||||
(parameters/parameters-interceptor)
|
||||
(muuntaja/format-negotiate-interceptor)
|
||||
(muuntaja/format-response-interceptor)
|
||||
(muuntaja/format-request-interceptor)
|
||||
(coercion/coerce-response-interceptor)
|
||||
(coercion/coerce-request-interceptor)
|
||||
(multipart/multipart-interceptor)]}})
|
||||
|
||||
(def config
|
||||
{:env :dev
|
||||
:io.pedestal.http/routes []
|
||||
:io.pedestal.http/type :jetty
|
||||
:io.pedestal.http/port 3000
|
||||
:io.pedestal.http/join? false
|
||||
:io.pedestal.http/secure-headers {:content-security-policy-settings
|
||||
{:default-src "'self'"
|
||||
:style-src "'self' 'unsafe-inline'"
|
||||
:script-src "'self' 'unsafe-inline'"}}
|
||||
::reitit-routes reitit-routes
|
||||
::reitit-ring-routes reitit-ring-routes
|
||||
::reitit-router-config reitit-router-config})
|
||||
|
||||
(defn reitit-http-router
|
||||
[{::keys [reitit-routes
|
||||
reitit-ring-routes
|
||||
reitit-router-config]
|
||||
:as config}]
|
||||
(reitit.pedestal/routing-interceptor
|
||||
(reitit.http/router
|
||||
(reitit-routes config)
|
||||
(reitit-router-config config))
|
||||
(->> config
|
||||
reitit-ring-routes
|
||||
(apply reitit.ring/routes))))
|
||||
|
||||
(defonce server (atom nil))
|
||||
|
||||
(defn start
|
||||
[server
|
||||
config]
|
||||
(when @server
|
||||
(io.pedestal.http/stop @server)
|
||||
(println "server stopped"))
|
||||
(-> config
|
||||
io.pedestal.http/default-interceptors
|
||||
(reitit.pedestal/replace-last-interceptor (reitit-http-router config))
|
||||
io.pedestal.http/dev-interceptors
|
||||
io.pedestal.http/create-server
|
||||
io.pedestal.http/start
|
||||
(->> (reset! server)))
|
||||
(println "server running in port 3000"))
|
||||
|
||||
#_(start server config)
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit-http with pedestal"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[io.pedestal/pedestal.service "0.6.3"]
|
||||
[io.pedestal/pedestal.jetty "0.6.3"]
|
||||
[metosin/reitit-pedestal "0.10.0"]
|
||||
[metosin/reitit "0.10.0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[io.pedestal/pedestal.service "0.5.5"]
|
||||
[io.pedestal/pedestal.jetty "0.5.5"]
|
||||
[metosin/reitit-pedestal "0.5.13"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
(defproject pedestal-example "0.1.0-SNAPSHOT"
|
||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit-http with pedestal"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[io.pedestal/pedestal.service "0.6.3"]
|
||||
[io.pedestal/pedestal.jetty "0.6.3"]
|
||||
[metosin/reitit-pedestal "0.10.0"]
|
||||
[metosin/reitit "0.10.0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[io.pedestal/pedestal.service "0.5.5"]
|
||||
[io.pedestal/pedestal.jetty "0.5.5"]
|
||||
[metosin/reitit-pedestal "0.5.13"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Ring App"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
(defproject ring-integrant-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Ring App with Integrant"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[integrant "0.8.1"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.1"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[metosin/reitit "0.5.13"]
|
||||
[integrant "0.7.0"]]
|
||||
:main example.server
|
||||
:repl-options {:init-ns user}
|
||||
:profiles {:dev {:dependencies [[integrant/repl "0.3.3"]]
|
||||
:profiles {:dev {:dependencies [[integrant/repl "0.3.1"]]
|
||||
:source-paths ["dev"]}})
|
||||
|
|
|
|||
|
|
@ -1,8 +0,0 @@
|
|||
(defproject ring-malli-lite-swagger "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Ring App with Swagger"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[metosin/jsonista "0.3.8"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]]
|
||||
:repl-options {:init-ns example.server}
|
||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
(ns example.server-test
|
||||
(:require [clojure.test :refer [deftest testing is]]
|
||||
[example.server :refer [app]]
|
||||
[ring.mock.request :refer [request json-body]]))
|
||||
|
||||
(deftest example-server
|
||||
|
||||
(testing "GET"
|
||||
(is (= (-> (request :get "/math/plus?x=20&y=3")
|
||||
app :body slurp)
|
||||
(-> {:request-method :get :uri "/math/plus" :query-string "x=20&y=3"}
|
||||
app :body slurp)
|
||||
(-> {:request-method :get :uri "/math/plus" :query-params {:x 20 :y 3}}
|
||||
app :body slurp)
|
||||
"{\"total\":23}")))
|
||||
|
||||
(testing "POST"
|
||||
(is (= (-> (request :post "/math/plus") (json-body {:x 40 :y 2})
|
||||
app :body slurp)
|
||||
(-> {:request-method :post :uri "/math/plus" :body-params {:x 40 :y 2}}
|
||||
app :body slurp)
|
||||
"{\"total\":42}")))
|
||||
|
||||
(testing "Download"
|
||||
(is (= (-> {:request-method :get :uri "/files/download"}
|
||||
app :body (#(slurp % :encoding "ascii")) count) ;; binary
|
||||
(.length (clojure.java.io/file "resources/reitit.png"))
|
||||
506325)))
|
||||
|
||||
(testing "Upload"
|
||||
(let [file (clojure.java.io/file "resources/reitit.png")
|
||||
multipart-temp-file-part {:tempfile file
|
||||
:size (.length file)
|
||||
:filename (.getName file)
|
||||
:content-type "image/png;"}]
|
||||
(is (= (-> {:request-method :post :uri "/files/upload" :multipart-params {:file multipart-temp-file-part}}
|
||||
app :body slurp)
|
||||
"{\"name\":\"reitit.png\",\"size\":506325}")))))
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# reitit-ring, malli, swagger, openapi 3
|
||||
# reitit-ring, malli, swagger
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -7,10 +7,6 @@
|
|||
(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/):
|
||||
|
||||
```bash
|
||||
|
|
@ -24,4 +20,4 @@ http GET :3000/swagger.json
|
|||
|
||||
## License
|
||||
|
||||
Copyright © 2017-2023 Metosin Oy
|
||||
Copyright © 2017-2019 Metosin Oy
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
(defproject ring-malli-swagger "0.1.0-SNAPSHOT"
|
||||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Ring App with Swagger"
|
||||
: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"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[metosin/jsonista "0.2.6"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server}
|
||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.3.2"]]}})
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
(ns example.server
|
||||
(:require [reitit.ring :as ring]
|
||||
[reitit.coercion.malli]
|
||||
[reitit.openapi :as openapi]
|
||||
[reitit.ring.malli]
|
||||
[reitit.swagger :as swagger]
|
||||
[reitit.swagger-ui :as swagger-ui]
|
||||
|
|
@ -12,7 +11,7 @@
|
|||
[reitit.ring.middleware.multipart :as multipart]
|
||||
[reitit.ring.middleware.parameters :as parameters]
|
||||
; [reitit.ring.middleware.dev :as dev]
|
||||
[reitit.ring.spec :as spec]
|
||||
; [reitit.ring.spec :as spec]
|
||||
; [spec-tools.spell :as spell]
|
||||
[ring.adapter.jetty :as jetty]
|
||||
[muuntaja.core :as m]
|
||||
|
|
@ -25,28 +24,13 @@
|
|||
[["/swagger.json"
|
||||
{:get {:no-doc true
|
||||
:swagger {:info {:title "my-api"
|
||||
:description "swagger docs with [malli](https://github.com/metosin/malli) and reitit-ring"
|
||||
:version "0.0.1"}
|
||||
;; used in /secure APIs below
|
||||
:securityDefinitions {"auth" {:type :apiKey
|
||||
:in :header
|
||||
:name "Example-Api-Key"}}
|
||||
:description "with [malli](https://github.com/metosin/malli) and reitit-ring"}
|
||||
:tags [{:name "files", :description "file api"}
|
||||
{:name "math", :description "math api"}]}
|
||||
:handler (swagger/create-swagger-handler)}}]
|
||||
["/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)}}]
|
||||
|
||||
["/files"
|
||||
{:tags #{"files"}}
|
||||
{:swagger {:tags ["files"]}}
|
||||
|
||||
["/upload"
|
||||
{:post {:summary "upload a file"
|
||||
|
|
@ -60,8 +44,6 @@
|
|||
["/download"
|
||||
{:get {:summary "downloads a file"
|
||||
:swagger {:produces ["image/png"]}
|
||||
:responses {200 {:description "an image"
|
||||
:content {"image/png" {:schema string?}}}}
|
||||
:handler (fn [_]
|
||||
{:status 200
|
||||
:headers {"Content-Type" "image/png"}
|
||||
|
|
@ -70,52 +52,24 @@
|
|||
(io/input-stream))})}}]]
|
||||
|
||||
["/math"
|
||||
{:tags #{"math"}}
|
||||
{:swagger {:tags ["math"]}}
|
||||
|
||||
["/plus"
|
||||
{:get {:summary "plus with malli query parameters"
|
||||
:parameters {:query [:map
|
||||
[:x
|
||||
{:title "X parameter"
|
||||
:description "Description for X parameter"
|
||||
:json-schema/default 42}
|
||||
int?]
|
||||
[:y int?]]}
|
||||
:parameters {:query [:map [:x int?] [:y int?]]}
|
||||
:responses {200 {:body [:map [:total int?]]}}
|
||||
:handler (fn [{{{:keys [x y]} :query} :parameters}]
|
||||
{:status 200
|
||||
:body {:total (+ x y)}})}
|
||||
:post {:summary "plus with malli body parameters"
|
||||
:parameters {:body [:map
|
||||
[:x
|
||||
{:title "X parameter"
|
||||
:description "Description for X parameter"
|
||||
:json-schema/default 42}
|
||||
int?]
|
||||
[:y int?]]}
|
||||
:parameters {:body [:map [:x int?] [:y int?]]}
|
||||
:responses {200 {:body [:map [:total int?]]}}
|
||||
:handler (fn [{{{:keys [x y]} :body} :parameters}]
|
||||
{:status 200
|
||||
: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"}}))}}]]]
|
||||
:body {:total (+ x y)}})}}]]]
|
||||
|
||||
{;;: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
|
||||
:exception pretty/exception
|
||||
:data {:coercion (reitit.coercion.malli/create
|
||||
|
|
@ -123,16 +77,15 @@
|
|||
:error-keys #{#_:type :coercion :in :schema :value :errors :humanized #_:transformed}
|
||||
;; schema identity function (default: close all map schemas)
|
||||
:compile mu/closed-schema
|
||||
;; strip-extra-keys (affects only predefined transformers)
|
||||
;; strip-extra-keys (effects only predefined transformers)
|
||||
:strip-extra-keys true
|
||||
;; add/set default values
|
||||
:default-values true
|
||||
;; malli options
|
||||
:options nil})
|
||||
:muuntaja m/instance
|
||||
:middleware [;; swagger & openapi
|
||||
:middleware [;; swagger feature
|
||||
swagger/swagger-feature
|
||||
openapi/openapi-feature
|
||||
;; query-params & form-params
|
||||
parameters/parameters-middleware
|
||||
;; content-negotiation
|
||||
|
|
@ -153,9 +106,6 @@
|
|||
(swagger-ui/create-swagger-ui-handler
|
||||
{:path "/"
|
||||
:config {:validatorUrl nil
|
||||
:urls [{:name "swagger", :url "swagger.json"}
|
||||
{:name "openapi", :url "openapi.json"}]
|
||||
:urls.primaryName "openapi"
|
||||
:operationsSorter "alpha"}})
|
||||
(ring/create-default-handler))))
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 228 KiB |
|
|
@ -1,4 +1,4 @@
|
|||
# reitit-ring, clojure.spec, swagger, openapi 3
|
||||
# reitit-ring, clojure.spec, swagger
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -7,10 +7,6 @@
|
|||
(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/):
|
||||
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
(defproject ring-example "0.1.0-SNAPSHOT"
|
||||
:description "Reitit Ring App with Swagger"
|
||||
:dependencies [[org.clojure/clojure "1.11.2"]
|
||||
[ring/ring-jetty-adapter "1.12.1"]
|
||||
[metosin/reitit "0.10.0"]
|
||||
[metosin/ring-swagger-ui "5.9.0"]]
|
||||
:dependencies [[org.clojure/clojure "1.10.0"]
|
||||
[ring/ring-jetty-adapter "1.7.1"]
|
||||
[metosin/reitit "0.5.13"]]
|
||||
:repl-options {:init-ns example.server}
|
||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.4.0"]]}})
|
||||
:profiles {:dev {:dependencies [[ring/ring-mock "0.3.2"]]}})
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
(ns example.server
|
||||
(:require [reitit.ring :as ring]
|
||||
[reitit.coercion.spec]
|
||||
[reitit.openapi :as openapi]
|
||||
[reitit.swagger :as swagger]
|
||||
[reitit.swagger-ui :as swagger-ui]
|
||||
[reitit.ring.coercion :as coercion]
|
||||
|
|
@ -14,7 +13,6 @@
|
|||
; [reitit.ring.middleware.dev :as dev]
|
||||
; [reitit.ring.spec :as spec]
|
||||
; [spec-tools.spell :as spell]
|
||||
[spec-tools.core :as st]
|
||||
[ring.adapter.jetty :as jetty]
|
||||
[muuntaja.core :as m]
|
||||
[clojure.spec.alpha :as s]
|
||||
|
|
@ -27,12 +25,7 @@
|
|||
(s/def ::size int?)
|
||||
(s/def ::file-response (s/keys :req-un [::name ::size]))
|
||||
|
||||
;; Use data-specs to provide extra JSON-Schema properties:
|
||||
;; https://github.com/metosin/spec-tools/blob/master/docs/04_json_schema.md#annotated-specs
|
||||
(s/def ::x (st/spec {:spec int?
|
||||
:name "X parameter"
|
||||
:description "Description for X parameter"
|
||||
:json-schema/default 42}))
|
||||
(s/def ::x int?)
|
||||
(s/def ::y int?)
|
||||
(s/def ::total int?)
|
||||
(s/def ::math-request (s/keys :req-un [::x ::y]))
|
||||
|
|
@ -45,15 +38,9 @@
|
|||
{:get {:no-doc true
|
||||
:swagger {:info {:title "my-api"}}
|
||||
: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"
|
||||
{:tags ["files"]}
|
||||
{:swagger {:tags ["files"]}}
|
||||
|
||||
["/upload"
|
||||
{:post {:summary "upload a file"
|
||||
|
|
@ -67,8 +54,6 @@
|
|||
["/download"
|
||||
{:get {:summary "downloads a file"
|
||||
:swagger {:produces ["image/png"]}
|
||||
:responses {200 {:description "an image"
|
||||
:content {"image/png" {:schema string?}}}}
|
||||
:handler (fn [_]
|
||||
{:status 200
|
||||
:headers {"Content-Type" "image/png"}
|
||||
|
|
@ -76,7 +61,7 @@
|
|||
(io/resource "reitit.png"))})}}]]
|
||||
|
||||
["/math"
|
||||
{:tags ["math"]}
|
||||
{:swagger {:tags ["math"]}}
|
||||
|
||||
["/plus"
|
||||
{:get {:summary "plus with spec query parameters"
|
||||
|
|
@ -120,9 +105,6 @@
|
|||
(swagger-ui/create-swagger-ui-handler
|
||||
{:path "/"
|
||||
:config {:validatorUrl nil
|
||||
:urls [{:name "swagger" :url "swagger.json"}
|
||||
{:name "openapi" :url "openapi.json"}]
|
||||
:urls.primaryName "openapi"
|
||||
:operationsSorter "alpha"}})
|
||||
(ring/create-default-handler))))
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 228 KiB |
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue