luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-16 16:01:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix docs based on Miikka's comments

Browse source
This commit is contained in:
Tommi Reiman 2018-09-24 19:21:19 +03:00
parent ba28d52c1c
commit f14c982202
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -32,7 +32,7 @@
```
* `: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 undocumented (for Swagger)
* the default handler is not documented in Swagger
* new router option `:reitit.ring/default-options-handler` to change this behavior. Setting `nil` disables this.
* updated deps:

8
doc/ring/ring.md
View file

@ -33,7 +33,7 @@ Example router:
["/ping" {:get handler}]))
```
Match contains the ring-optimized `:result`:
Match contains `:result` compiled by the `ring-router`:
```clj
(require '[reitit.core :as r])
@ -89,7 +89,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 spesific 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).
@ -120,7 +120,7 @@ Method-level handler catches only the method:
; nil
```
By default, `:options` is also supported (ree router options to change this):
By default, `:options` is also supported (see router options to change this):
```clj
(app {:request-method :options, :uri "/ping"})
@ -139,7 +139,7 @@ Name-based reverse routing:
# Middleware
Middleware can be mounted using a `:middleware` key - either to top-level or under `:request-method` submap. It's 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