reitit/CHANGELOG.md

706 lines
24 KiB
Markdown
Raw Normal View History

2019-02-19 17:53:09 +00:00
## 0.3.0-SNAPSHOT
2019-02-03 08:51:00 +00:00
### `reitit.core`
* welcome new wildcard routing!
* optional bracket-syntax with parameters
* `"/user/:user-id"` = `"/user/{user-id}"`
* `"/assets/*asset"` = `"/assets/{*asset}`
* enabling qualified parameters
* `"/user/{my.user/id}/{my.order/id}"`
* parameters don't have to span whole segments
* `"/file-:id/topics"` (free start, ends at slash)
* `"/file-{name}.html"` (free start & end)
* backed by a new `:trie-router`, replacing `:segment-router`
* [over 40% faster](https://metosin.github.io/reitit/performance.html) on the JVM
* **BREAKING**: `reitit.spec/validate-spec!` has been renamed to `validate`
2019-02-19 17:40:13 +00:00
### `reitit-dev`
* new module for friendly router creation time exception handling
* new option `:exception` in `r/router`, of type `Exception => Exception` (default `reitit.exception/exception`)
2019-03-03 19:55:39 +00:00
* 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])
(r/router
[["/ping"]
["/:user-id/orders"]
["/bulk/:bulk-id"]
["/public/*path"]
["/:version/status"]]
{:exception pretty/exception})
```
<img src="https://gist.githubusercontent.com/ikitommi/ff9b091ffe87880d9847c9832bbdd3d2/raw/0e185e07e4ac49109bb653b4ad4656896cb41b2f/path-conflicts.png" width=640>
#### Route data error
```clj
(require '[reitit.spec :as spec])
(require '[clojure.spec.alpha :as s])
(s/def ::role #{:admin :user})
(s/def ::roles (s/coll-of ::role :into #{}))
(r/router
["/api/admin" {::roles #{:adminz}}]
{:validate spec/validate
:exception pretty/exception})
```
<img src="https://gist.githubusercontent.com/ikitommi/ff9b091ffe87880d9847c9832bbdd3d2/raw/0e185e07e4ac49109bb653b4ad4656896cb41b2f/route-data-error.png" width=640>
### `reitit-frontend`
* **BREAKING**: Frontend controllers redesigned
* Controller `:params` function has been deprecated
* Controller `:identity` function works the same as `:params`
* New `:parameters` option can be used to declare which parameters
controller is interested in, as data, which should cover most
use cases: `{:start start-fn, :parameters {:path [:foo-id]}}`
2019-03-01 09:43:55 +00:00
* Ensure HTML5 History routing works with IE11
### `reitit-ring`
2019-02-19 17:40:26 +00:00
* Allow Middleware to compile to `nil` with Middleware Registries, fixes to [#216](https://github.com/metosin/reitit/issues/216).
* **BREAKING**: `reitit.ring.spec/validate-spec!` has been renamed to `validate`
2019-02-19 17:40:26 +00:00
### `reitit-http`
2019-02-19 17:40:26 +00:00
* Allow Interceptors to compile to `nil` with Interceptor Registries, related to [#216](https://github.com/metosin/reitit/issues/216).
* **BREAKING**: `reitit.http.spec/validate-spec!` has been renamed to `validate`
## Dependencies
* updated:
```clj
[metosin/spec-tools "0.9.0"] is available but we use "0.8.3"
[metosin/schema-tools "0.11.0"] is available but we use "0.10.5"
```
2019-02-19 17:40:26 +00:00
2019-01-26 14:17:13 +00:00
## 0.2.13 (2019-01-26)
* Don't throw `StringIndexOutOfBoundsException` with empty path lookup on wildcard paths, fixes [#209](https://github.com/metosin/reitit/issues/209)
2019-01-18 06:56:23 +00:00
## 0.2.12 (2019-01-18)
* fixed reflection & boxed math warnings, fixes [#207](https://github.com/metosin/reitit/issues/207)
* fixed arity-error on default routes with `reitit-ring` & `reitit-http` when `:inject-router?` set to `false`.
2019-01-17 17:43:04 +00:00
## 0.2.11 (2019-01-17)
* new guide on [pretty printing spec coercion errors with expound](https://metosin.github.io/reitit/ring/coercion.html#pretty-printing-spec-errors), fixes [#153](https://github.com/metosin/reitit/issues/153).
2019-01-14 08:07:16 +00:00
### `reitit-core`
* `reitit.core/Expand` can be extended, fixes [#201](https://github.com/metosin/reitit/issues/201).
2019-01-17 08:10:24 +00:00
* new snappy Java-backed `SegmentTrie` routing algorithm and data structure backing `reitit.core/segment-router`, making wildcard routing 2x faster on the JVM
* `reitit.core/linear-router` uses the segment router behind the scenes, 2-4x faster on the JVM too.
2019-01-14 08:07:16 +00:00
2019-01-14 19:53:37 +00:00
### `reitit-ring`
* new options `:inject-match?` and `:inject-router?` on `reitit.ring/ring-handler` to optionally not to inject `Router` and `Match` into the request. See [performance guide](https://metosin.github.io/reitit/performance.html#faster!) for details.
### `reitit-http`
* new options `:inject-match?` and `:inject-router?` on `reitit.http/ring-handler` and `reitit.http/routing-interceptor` to optionally not to inject `Router` and `Match` into the request. See [performance guide](https://metosin.github.io/reitit/performance.html#faster!) for details.
### dependencies
2019-01-17 17:22:21 +00:00
* updated:
```clj
[metosin/spec-tools "0.8.3"] is available but we use "0.8.2"
```
2018-12-30 15:48:27 +00:00
## 0.2.10 (2018-12-30)
2018-12-27 14:01:31 +00:00
### `reitit-core`
* `segment-router` doesn't accept empty segments as path-parameters, fixes [#181](https://github.com/metosin/reitit/issues/181).
* path-params are decoded correctly with `r/match-by-name`, fixes [#192](https://github.com/metosin/reitit/issues/192).
2018-12-22 08:37:18 +00:00
* new `:quarantine-router`, which is uses by default if there are any path conflicts: uses internally `:mixed-router` for non-conflicting routes and `:linear-router` for conflicting routes.
```clj
2018-12-27 14:01:31 +00:00
(-> [["/joulu/kinkku"] ;; linear-router
["/joulu/:torttu"] ;; linear-router
2018-12-22 08:37:18 +00:00
["/tonttu/:id"] ;; segment-router
["/manna/puuro"] ;; lookup-router
["/sinappi/silli"]] ;; lookup-router
(r/router {:conflicts nil})
(r/router-name))
; => :quarantine-router
```
2018-12-30 15:18:04 +00:00
* `reitit.interceptor/transform-butlast` helper to transform the interceptor chains (last one is usually the handler).
2018-12-30 14:53:15 +00:00
## `reitit-middleware`
* `reitit.ring.middleware.dev/print-request-diffs` middleware transformation function to print out request diffs between middleware to the console
* read the [docs](https://metosin.github.io/reitit/ring/transforming_middleware_chain.html#printing-request-diffs)
* see [example app](https://github.com/metosin/reitit/tree/master/examples/ring-swagger)
<img src="https://metosin.github.io/reitit/images/ring-request-diff.png" width=320>
## `reitit-interceptors`
* `reitit.http.interceptors.dev/print-context-diffs` interceptor transformation function to print out context diffs between interceptor steps to the console:
* read the [docs](https://metosin.github.io/reitit/http/transforming_interceptor_chain.html#printing-context-diffs)
* see [example app](https://github.com/metosin/reitit/tree/master/examples/http-swagger)
<img src="https://metosin.github.io/reitit/images/http-context-diff.png" width=320>
2018-12-30 15:32:05 +00:00
## `reitit-sieppari`
* New version of Sieppari allows interceptors to run on ClojureScript too.
### `reitit-pedestal`
* new optional module for [Pedestal](http://pedestal.io/) integration. See [the docs](https://metosin.github.io/reitit/http/pedestal.html).
2018-12-27 14:01:31 +00:00
### dependencies
* updated:
2018-12-22 07:53:40 +00:00
```clj
[metosin/muuntaja "0.6.3"] is available but we use "0.6.1"
2018-12-30 15:32:05 +00:00
[metosin/sieppari "0.0.0-alpha6"] is available but we use "0.0.0-alpha7"
2018-12-22 07:53:40 +00:00
```
## 0.2.9 (2018-11-21)
2018-12-27 14:01:31 +00:00
### `reitit-spec`
* support for vector data-specs for request & response parameters by [Heikki Hämäläinen](https://github.com/hjhamala).
2018-11-18 20:31:13 +00:00
## 0.2.8 (2018-11-18)
2018-11-17 18:50:04 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-core`
* Added support for composing middleware & interceptor transformations, fixes [#167](https://github.com/metosin/reitit/issues/167).
2018-12-27 14:01:31 +00:00
### `reitit-spec`
2018-11-17 18:50:04 +00:00
* 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])
(require '[reitit.ring.middleware.exception :as exception])
(require '[reitit.ring.coercion :as coercion])
(require '[expound.alpha :as expound])
(defn coercion-error-handler [status]
(let [printer (expound/custom-printer {:theme :figwheel-theme, :print-specs? false})
handler (exception/create-coercion-handler status)]
(fn [exception request]
(printer (-> exception ex-data :problems))
(handler exception request))))
(def app
(ring/ring-handler
(ring/router
["/plus"
{:get
{: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)}})}}]
{:data {:coercion reitit.coercion.spec/coercion
:middleware [(exception/create-exception-middleware
(merge
exception/default-handlers
{:reitit.coercion/request-coercion (coercion-error-handler 400)
:reitit.coercion/response-coercion (coercion-error-handler 500)}))
coercion/coerce-request-middleware
coercion/coerce-response-middleware]}})))
(app
{:uri "/plus"
:request-method :get
:query-params {"x" "1", "y" "fail"}})
(app
{:uri "/plus"
:request-method :get
:query-params {"x" "1", "y" "-2"}})
```
2018-12-27 14:01:31 +00:00
### `reitit-swagger`
2018-11-17 19:26:52 +00:00
* `create-swagger-handler` support now 3-arity ring-async, thanks to [Miloslav Nenadál](https://github.com/nenadalm)
2018-11-11 20:03:16 +00:00
## 0.2.7 (2018-11-11)
2018-12-27 14:01:31 +00:00
### `reitit-spec`
2018-11-11 20:03:16 +00:00
* Fixes [spec coercion issue with aliased specs](https://github.com/metosin/spec-tools/issues/145)
* updated deps:
```clj
[metosin/spec-tools "0.8.2"] is available but we use "0.8.1"
```
2018-11-09 13:41:13 +00:00
## 0.2.6 (2018-11-09)
2018-11-04 19:05:34 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-core`
2018-11-04 19:05:34 +00:00
2018-11-08 12:29:31 +00:00
* Faster path-parameter decoding: doing less work when parameters don't need decoding. Wildcard-routing is now 10-15% faster in perf tests (opensensors & github api).
* Fixed a ClojureScript compiler warning about private var usage. [#169](https://github.com/metosin/reitit/issues/169)
2018-11-04 19:05:34 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-ring`
2018-11-04 19:05:34 +00:00
* `redirect-trailing-slash-handler` can strip multiple slashes from end of the uri, by [Hannu Hartikainen](https://github.com/dancek).
2018-11-08 12:29:31 +00:00
* Fixed a ClojureScript compiler warning about `satisfies?` being a macro.
2018-11-04 19:05:34 +00:00
2018-11-09 13:38:11 +00:00
* updated deps:
```clj
[ring "1.7.1"] is available but we use "1.7.0"
```
2018-12-27 14:01:31 +00:00
### `reitit-spec`
2018-11-09 13:38:11 +00:00
* updated deps:
```clj
[metosin/spec-tools "0.8.1"] is available but we use "0.8.0"
```
2018-12-27 14:01:31 +00:00
### `reitit-schema`
2018-11-09 13:38:11 +00:00
* updated deps:
```clj
[metosin/schema-tools "0.10.5"] is available but we use "0.10.4"
```
2018-12-27 14:01:31 +00:00
### `reitit-sieppari`
2018-11-09 13:38:11 +00:00
* updated deps:
```clj
[metosin/sieppari "0.0.0-alpha6"] is available but we use "0.0.0-alpha5"
```
2018-10-30 18:24:44 +00:00
## 0.2.5 (2018-10-30)
2018-12-27 14:01:31 +00:00
### `reitit-ring`
* router is injected into request also in the default branch
2018-10-30 17:57:13 +00:00
* new `reitit.ring/redirect-trailing-slash-handler` to [handle trailing slashes](https://metosin.github.io/reitit/ring/slash_handler.html) with style!
* Fixes [#92](https://github.com/metosin/reitit/issues/92), thanks to [valerauko](https://github.com/valerauko).
```clj
(require '[reitit.ring :as ring])
(def app
(ring/ring-handler
(ring/router
[["/ping" (constantly {:status 200, :body ""})]
["/pong/" (constantly {:status 200, :body ""})]])
(ring/redirect-trailing-slash-handler)))
(app {:uri "/ping/"})
; {:status 308, :headers {"Location" "/ping"}, :body ""}
(app {:uri "/pong"})
; {:status 308, :headers {"Location" "/pong/"}, :body ""}
```
2018-10-30 18:24:44 +00:00
* updated deps:
```clj
[ring/ring-core "1.7.1"] is available but we use "1.7.0"
```
2018-12-27 14:01:31 +00:00
### `reitit-http`
* router is injected into request also in the default branch
2018-10-30 18:33:15 +00:00
## 0.2.4 (2018-10-21)
2018-10-16 17:32:40 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-ring`
2018-10-16 17:32:40 +00:00
* New option `:not-found-handler` in `reitit.ring/create-resource-handler` to set how 404 is handled. Fixes [#89](https://github.com/metosin/reitit/issues/89), thanks to [valerauko](https://github.com/valerauko).
2018-12-27 14:01:31 +00:00
### `reitit-spec`
2018-10-16 17:32:40 +00:00
2018-10-21 20:14:08 +00:00
* Latest features from [spec-tools](https://github.com/metosin/spec-tools)
* Swagger enchancements
2018-10-21 17:06:28 +00:00
* Better spec coercion via `st/coerce` using spec walking & inference: many 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`) can be transformed without needing spec to be wrapped. Fallbacks to old conformed based approach.
2018-10-21 17:37:35 +00:00
* [example app](https://github.com/metosin/reitit/blob/master/examples/ring-spec-swagger/src/example/server.clj).
2018-10-16 17:32:40 +00:00
* updated deps:
```clj
2018-10-21 17:37:35 +00:00
[metosin/spec-tools "0.8.0"] is available but we use "0.7.1"
2018-10-16 17:32:40 +00:00
```
2018-09-24 17:51:43 +00:00
## 0.2.3 (2018-09-24)
2018-09-22 18:23:33 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-ring`
2018-09-22 18:23:33 +00:00
2018-09-22 18:47:55 +00:00
* `ring-handler` takes optionally a 3rd argument, an options map which can be used to se top-level middleware, applied before any routing is done:
```clj
(require '[reitit.ring :as ring])
(defn wrap [handler id]
(fn [request]
(handler (update request ::acc (fnil conj []) id))))
(defn handler [{:keys [::acc]}]
{:status 200, :body (conj acc :handler)})
(def app
(ring/ring-handler
(ring/router
["/api" {:middleware [[mw :api]]}
["/get" {:get handler}]])
(ring/create-default-handler)
{:middleware [[mw :top]]}))
(app {:request-method :get, :uri "/api/get"})
; {:status 200, :body [:top :api :ok]}
(require '[reitit.core :as r])
(-> app (ring/get-router))
; #object[reitit.core$single_static_path_router]
```
2018-09-23 08:15:11 +00:00
* `:options` requests are served for all routes by default with 200 OK to better support things like [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)
2018-09-24 16:21:19 +00:00
* the default handler is not documented in Swagger
2018-09-23 08:15:11 +00:00
* new router option `:reitit.ring/default-options-handler` to change this behavior. Setting `nil` disables this.
2018-09-22 18:23:33 +00:00
* updated deps:
```clj
[ring/ring-core "1.7.0"] is available but we use "1.6.3"
```
2018-12-27 14:01:31 +00:00
### `reitit-http`
2018-09-24 17:21:53 +00:00
* `:options` requests are served for all routes by default with 200 OK to better support things like [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)
* the default handler is not documented in Swagger
* new router option `:reitit.http/default-options-handler` to change this behavior. Setting `nil` disables this.
2018-12-27 14:01:31 +00:00
### `reitit-middleware`
2018-09-23 13:42:45 +00:00
* fix `reitit.ring.middleware.parameters/parameters-middleware`
2018-09-23 13:49:10 +00:00
* updated deps:
```clj
[metosin/muuntaja "0.6.1"] is available but we use "0.6.0"
```
2018-12-27 14:01:31 +00:00
### `reitit-swagger-ui`
2018-09-23 13:49:10 +00:00
* updated deps:
```clj
[metosin/jsonista "0.2.2"] is available but we use "0.2.1"
```
2018-09-09 19:03:57 +00:00
## 0.2.2 (2018-09-09)
2018-09-08 07:52:39 +00:00
* better documentation for interceptors
* sample apps:
* [Sieppari, reitit-http & swagger](https://github.com/metosin/reitit/blob/master/examples/http-swagger/src/example/server.clj)
* [Pedestal, reitit-http & swagger](https://github.com/metosin/reitit/blob/master/examples/pedestal-swagger/src/example/server.clj)
2018-12-27 14:01:31 +00:00
### `reitit-middleware`
2018-09-08 07:52:39 +00:00
* new middleware `reitit.ring.middleware.parameters/parameters-middleware` to wrap query & form params.
2018-12-27 14:01:31 +00:00
### `reitit-interceptors`
2018-09-08 07:52:39 +00:00
* new module like `reitit-middleware` but for interceptors. See the [Docs](https://metosin.github.io/reitit/http/default_interceptors.html).
2018-09-04 15:15:23 +00:00
## 0.2.1 (2018-09-04)
2018-12-27 14:01:31 +00:00
### `reitit-schema`
2018-09-04 15:15:23 +00:00
* updated deps:
```clj
[metosin/schema-tools "0.10.4"] is available but we use "0.10.3"
```
2018-12-27 14:01:31 +00:00
### `reitit-middleware`
2018-09-04 15:15:23 +00:00
* updated deps:
```clj
[metosin/muuntaja "0.6.0"] is available but we use "0.6.0-alpha5"
```
2018-09-03 17:12:53 +00:00
## 0.2.0 (2018-09-03)
2018-07-16 06:34:52 +00:00
2018-08-31 12:13:33 +00:00
Sample apps demonstraing the current status of `reitit`:
2018-09-03 19:26:25 +00:00
* [`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-frontent` with Keechma-style controllers](https://github.com/metosin/reitit/blob/master/examples/frontend-controllers/src/frontend/core.cljs)
* [`reitit-http` with Pedestal](https://github.com/metosin/reitit/blob/master/examples/pedestal/src/example/server.clj)
* [`reitit-http` with Sieppari](https://github.com/metosin/reitit/blob/master/examples/http/src/example/server.clj)
2018-08-31 12:13:33 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-core`
2018-07-16 13:01:34 +00:00
* **BREAKING**: the router option key to extract body format has been renamed: `:extract-request-format` => `:reitit.coercion/extract-request-format`
* should only concern you if you are not using [Muuntaja](https://github.com/metosin/muuntaja).
2018-07-18 09:17:16 +00:00
* the `r/routes` returns just the path + data tuples as documented, not the compiled route results. To get the compiled results, use `r/compiled-routes` instead.
2018-08-01 16:38:16 +00:00
* new [faster](https://github.com/metosin/reitit/blob/master/perf-test/clj/reitit/impl_perf_test.clj) and more correct encoders and decoders for query & path params.
2018-08-08 08:25:58 +00:00
* all path-parameters are now decoded correctly with `reitit.impl/url-decode`, thanks to [Matthew Davidson](https://github.com/KingMob)!
2018-08-01 16:46:47 +00:00
* query-parameters are encoded with `reitit.impl/form-encode`, so spaces are `+` instead of `%20`.
* correctly read `:header` params from request `:headers`, not `:header-params`
2018-07-21 05:49:20 +00:00
* welcome route name conflict resolution! If router has routes with same names, router can't be created. fix 'em.
2018-07-26 07:07:49 +00:00
* sequential child routes are allowed, enabling this:
```clj
(-> ["/api"
(for [i (range 4)]
[(str "/" i)])]
(r/router)
(r/routes))
;[["/api/0" {}]
; ["/api/1" {}]
; ["/api/2" {}]
; ["/api/3" {}]]
```
2018-07-16 13:01:34 +00:00
2018-07-28 09:01:12 +00:00
* A [Guide to compose routers](https://metosin.github.io/reitit/advanced/composing_routers.html)
2018-07-27 12:25:03 +00:00
* Welcome Middleware and Intercetor Registries!
2018-07-28 09:01:12 +00:00
* when Keywords are used in place of middleware / interceptor, a lookup is done into Router option `::middleware/registry` (or `::interceptor/registry`) with the key. Fails fast with missing registry entries.
* fixes [#32](https://github.com/metosin/reitit/issues/32).
* full documentation [here](https://metosin.github.io/reitit/ring/middleware_registry.html).
2018-07-27 12:25:03 +00:00
```clj
2018-07-28 09:01:12 +00:00
(require '[reitit.ring :as ring])
(require '[reitit.middleware :as middleware])
(defn wrap-bonus [handler value]
(fn [request]
(handler (update request :bonus (fnil + 0) value))))
2018-07-27 12:25:03 +00:00
2018-07-28 09:01:12 +00:00
(def app
(ring/ring-handler
(ring/router
["/api" {:middleware [[:bonus 20]]}
["/bonus" {:middleware [:bonus10]
:get (fn [{:keys [bonus]}]
{:status 200, :body {:bonus bonus}})}]]
{::middleware/registry {:bonus wrap-bonus
:bonus10 [:bonus 10]}})))
(app {:request-method :get, :uri "/api/bonus"})
; {:status 200, :body {:bonus 30}}
```
2018-07-27 12:25:03 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-swagger`
2018-07-21 06:42:51 +00:00
* In case of just one swagger api per router, the swagger api doesn't have to identified, so this works now:
```clj
(require '[reitit.ring :as ring])
(require '[reitit.swagger :as swagger])
(require '[reitit.swagger-ui :as swagger-ui])
(ring/ring-handler
(ring/router
[["/ping"
{:get (fn [_] {:status 200, :body "pong"})}]
["/swagger.json"
{:get {:no-doc true
:handler (swagger/create-swagger-handler)}}]])
(swagger-ui/create-swagger-ui-handler {:path "/"}))
```
2018-12-27 14:01:31 +00:00
### `reitit-middleware`
2018-08-03 10:10:16 +00:00
* A new module with common data-driven middleware: exception handling, content negotiation & multipart requests. See [the docs](https://metosin.github.io/reitit/ring/default_middleware.html).
2018-12-27 14:01:31 +00:00
### `reitit-swagger-ui`
2018-07-16 06:34:52 +00:00
* **BREAKING**: pass swagger-ui `:config` as-is (instead of mixed-casing keys) to swagger-ui, fixes [#109](https://github.com/metosin/reitit/issues/109):
* see [docs](https://github.com/swagger-api/swagger-ui/tree/2.x#parameters) for available parameters.
```clj
(swagger-ui/create-swagger-ui-handler
{:path "/"
:url "/api/swagger.json"
:config {:jsonEditor true
:validatorUrl nil}})
```
2018-12-27 14:01:31 +00:00
### `reitit-frontend`
2018-08-31 12:13:33 +00:00
* new module for frontend-routing. See [docs](https://metosin.github.io/reitit/frontend/basics.html) for details.
2018-06-25 14:52:48 +00:00
## 0.1.3 (2018-6-25)
2018-06-14 10:40:17 +00:00
2018-12-27 14:01:31 +00:00
### `reitit-core`
2018-06-14 10:40:17 +00:00
2018-06-14 10:40:32 +00:00
* `reitit.coercion/coerce!` coerced all parameters found in match, e.g. injecting in `:query-parameters` into `Match` with coerce those too if `:query` coercion is defined.
* if response coercion is not defined for a response status, response is still returned
2018-06-14 10:40:17 +00:00
* `spec-tools.data-spec/maybe` can be used in spec-coercion.
2018-06-14 10:40:32 +00:00
```clj
(def router
(reitit.core/router
["/spec" {:coercion reitit.coercion.spec/coercion}
["/:number/:keyword" {:parameters {:path {:number int?
:keyword keyword?}
:query (ds/maybe {:int int?})}}]]
{:compile reitit.coercion/compile-request-coercers}))
(-> (reitit.core/match-by-path router "/spec/10/kikka")
(assoc :query-params {:int "10"})
(reitit.coercion/coerce!))
; {:path {:number 10, :keyword :kikka}
; :query {:int 10}}
```
* `reitit.core/match->path` to create full paths from match, including the query parameters:
```clj
(require '[reitit.core :as r])
(-> (r/router ["/:a/:b" ::route])
(r/match-by-name! ::route {:a "olipa", :b "kerran"})
(r/match->path))
; "/olipa/kerran"
(-> (r/router ["/:a/:b" ::route])
(r/match-by-name! ::route {:a "olipa", :b "kerran"})
(r/match->path {:iso "pöriläinen"}))
; "/olipa/kerran?iso=p%C3%B6ril%C3%A4inen"
```
2018-06-24 19:29:08 +00:00
### `reitit-spec`
* `[metosin/spec-tools "0.7.1"]` with swagger generation enhancements, see the [CHANGELOG](https://github.com/metosin/spec-tools/blob/master/CHANGELOG.md)
* if response coercion is not defined for a response status, no `:schema` is not emitted.
* updated dependencies:
```clj
[metosin/spec-tools "0.7.1"] is available but we use "0.7.0"
```
### `reitit-schema`
* if response coercion is not defined for a response status, no `:schema` is not emitted.
2018-06-06 07:42:03 +00:00
## 0.1.2 (2018-6-6)
2018-05-26 17:38:15 +00:00
2018-06-03 14:48:47 +00:00
### `reitit-core`
2018-06-04 07:30:48 +00:00
* Better handling of `nil` in route syntax:
* explicit `nil` after path string is always handled as `nil` route
* `nil` as path string causes the whole route to be `nil`
* `nil` as child route is stripped away
2018-06-03 14:48:47 +00:00
```clj
2018-06-04 07:30:48 +00:00
(testing "nil routes are stripped"
2018-06-03 14:48:47 +00:00
(is (= [] (r/routes (r/router nil))))
2018-06-04 07:30:48 +00:00
(is (= [] (r/routes (r/router [nil ["/ping"]]))))
2018-06-03 14:48:47 +00:00
(is (= [] (r/routes (r/router [nil [nil] [[nil nil nil]]]))))
2018-06-04 07:30:48 +00:00
(is (= [] (r/routes (r/router ["/ping" [nil "/pong"]])))))
2018-06-03 14:48:47 +00:00
```
2018-06-04 21:08:31 +00:00
### `reitit-ring`
* Use HTTP redirect (302) with index-files in `reitit.ring/create-resource-handler`.
2018-06-05 06:39:39 +00:00
* `reitit.ring/create-default-handler` now conforms to [RING Spec](https://github.com/ring-clojure/ring/blob/master/SPEC), Fixes [#83](https://github.com/metosin/reitit/issues/83)
2018-05-26 17:38:15 +00:00
### `reitit-schema`
* updated dependencies:
```clj
[metosin/schema-tools "0.10.3"] is available but we use "0.10.2"
```
### `reitit-swagger`
* Fix Swagger-paths, by [Kirill Chernyshov](https://github.com/DeLaGuardo).
### `reitit-swagger-ui`
2018-06-04 21:08:31 +00:00
* Use HTTP redirect (302) with index-files in `reitit.swagger-ui/create-swagger-ui-handler`.
2018-05-26 17:38:15 +00:00
* updated dependencies:
```clj
[metosin/jsonista "0.2.1"] is available but we use "0.2.0"
```
2018-05-20 18:55:46 +00:00
## 0.1.1 (2018-5-20)
2018-03-21 05:56:50 +00:00
### `reitit-core`
2018-05-14 05:44:41 +00:00
* `linear-router` now works with unnamed catch-all parameters, e.g. `"/files/*"`
2018-03-21 06:02:49 +00:00
* `match-by-path` encodes parameters into strings using (internal) `reitit.impl/IntoString` protocol. Handles all of: strings, numbers, keywords, booleans, objects. Fixes [#75](https://github.com/metosin/reitit/issues/75).
2018-03-21 05:56:50 +00:00
```clj
(require '[reitit.core :as r])
(r/match-by-name
(r/router
["/coffee/:type" ::coffee])
::coffee
{:type :luwak})
;#Match{:template "/coffee/:type",
; :data {:name :user/coffee},
; :result nil,
; :path-params {:type "luwak"},
2018-03-21 06:02:49 +00:00
; :path "/coffee/luwak"}
2018-03-21 05:56:50 +00:00
```
2018-04-23 05:27:16 +00:00
### `reitit-ring`
* `reitit.ring/default-handler` now works correctly with async ring
* new helper `reitit.ring/router` to compose routes outside of a router.
2018-05-14 05:46:13 +00:00
* `reitit.ring/create-resource-handler` function to serve static routes. See [docs](https://metosin.github.io/reitit/ring/static.html).
2018-04-23 05:27:16 +00:00
2018-04-25 05:32:01 +00:00
* new dependencies:
```clj
[ring/ring-core "1.6.3"]
```
2018-03-21 05:58:06 +00:00
### `reitit-swagger`
2018-05-20 18:58:10 +00:00
* New module to produce swagger-docs from routing tree, including `Coercion` definitions. Works with both middleware & interceptors and Schema & Spec. See [docs](https://metosin.github.io/reitit/ring/swagger.html) and [example project](https://github.com/metosin/reitit/tree/master/examples/ring-swagger).
2018-05-14 05:44:41 +00:00
### `reitit-swagger-ui`
New module to server pre-integrated [Swagger-ui](https://github.com/swagger-api/swagger-ui). See [docs](https://metosin.github.io/reitit/ring/swagger.html#swagger-ui).
* new dependencies:
```clj
[metosin/jsonista "0.2.0"]
[metosin/ring-swagger-ui "2.2.10"]
```
2018-05-14 05:46:13 +00:00
### dependencies
2018-03-21 05:58:06 +00:00
```clj
2018-05-14 13:50:20 +00:00
[metosin/spec-tools "0.7.0"] is available but we use "0.6.1"
2018-05-14 05:44:41 +00:00
[metosin/schema-tools "0.10.2"] is available but we use "0.10.1"
2018-03-21 05:58:06 +00:00
```
2018-02-19 05:44:29 +00:00
## 0.1.0 (2018-2-19)
2017-08-07 11:08:39 +00:00
2018-02-19 05:44:29 +00:00
* First release