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

docs

Browse source
This commit is contained in:
Tommi Reiman 2018-05-20 21:41:38 +03:00
parent 5fa02c6ff2
commit 1262a1fab7
4 changed files with 25 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -127,10 +127,14 @@ Invalid request:
; :in [:y]}],
; :value {:x "1", :y "a"},
; :in [:request :query-params]}}
```
**NOTE**: Reitit is not a batteries included web-stack. You should also include at least:
* content negotiation library like [Muuntaja](https://github.com/metosin/muuntaja)
* some default Ring-middleware like `ring.middleware.params/wrap-params`
See [Ring with Swagger Example](/tree/master/examples/ring-swagger) for a runnable example. Plan is to have more batteries as separate modules, templates and example projects. Stay tuned.
## More info
[Check out the full documentation!](https://metosin.github.io/reitit/)

1
doc/ring/static.md
View file

@ -55,7 +55,6 @@ A better way to serve files from conflicting paths, e.g. `"/*"`, is to serve the
| :path | optional path to mount the handler to. Works only if mounted outside of 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"]`
| :allow-symlinks? | allow symlinks that lead to paths outside the root classpath directories, defaults to `false`
### TODO

36
modules/reitit-ring/src/reitit/ring.cljc
View file

@ -5,7 +5,8 @@
[reitit.impl :as impl]
#?@(:clj [
[ring.util.mime-type :as mime-type]
[ring.util.response :as response]])))
[ring.util.response :as response]])
[clojure.string :as str]))
(def http-methods #{:get :head :post :put :delete :connect :options :trace :patch})
(defrecord Methods [get head post put delete connect options trace patch])
@ -71,6 +72,7 @@
;; TODO: optimize for perf
;; TODO: ring.middleware.not-modified/wrap-not-modified
;; TODO: ring.middleware.head/wrap-head
;; TODO: handle etags
(defn create-resource-handler
"A ring handler for serving classpath resources, configured via options:
@ -80,8 +82,7 @@
| :root | optional resource root, defaults to `\"public\"`
| :path | optional path to mount the handler to. Works only if mounted outside of 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\"]`
| :allow-symlinks? | allow symlinks that lead to paths outside the root classpath directories, defaults to `false`"
| :index-files | optional vector of index-files to look in a resource directory, defaults to `[\"index.html\"]`"
([]
(create-resource-handler nil))
([{:keys [parameter root path loader allow-symlinks? index-files paths]
@ -90,30 +91,29 @@
index-files ["index.html"]
paths (constantly nil)}}]
(let [options {:root root, :loader loader, :allow-symlinks? allow-symlinks?}
path-size (inc (count path))
path-size (count path)
create (fn [handler]
(fn
([request] (handler request))
([request respond _] (respond (handler request)))))
resource-response (fn [path accept]
(if-let [path (accept path)]
(if-let [response (or (paths path) (response/resource-response path options))]
(response/content-type response (mime-type/ext-mime-type path)))))
path-or-index-response (fn [path accept]
(or (resource-response path accept)
(loop [[file & files] index-files]
(if file
(or (resource-response (str path "/" file) accept)
(recur files))))))
resource-response (fn [path]
(if-let [response (or (paths path) (response/resource-response path options))]
(response/content-type response (mime-type/ext-mime-type path))))
path-or-index-response (fn [path]
(or (resource-response path)
(let [separator (if-not (str/ends-with? path "/") "/")]
(loop [[file & files] index-files]
(if file
(or (resource-response (str path separator file))
(recur files)))))))
handler (if path
(fn [request]
(let [uri (:uri request)]
(path-or-index-response uri (fn [path]
(if (>= (count path) path-size)
(subs path path-size))))))
(if-let [path (if (>= (count uri) path-size) (subs uri path-size))]
(path-or-index-response path))))
(fn [request]
(let [path (-> request :path-params parameter)]
(or (path-or-index-response path identity) {:status 404}))))]
(or (path-or-index-response path) {:status 404}))))]
(create handler)))))
(defn ring-handler

1
project.clj
View file

@ -53,6 +53,7 @@
[orchestra "2017.11.12-1"]
[ring "1.6.3"]
[ikitommi/immutant-web "3.0.0-alpha1"]
[metosin/muuntaja "0.5.0"]
[metosin/jsonista "0.2.0"]
[metosin/ring-swagger-ui "2.2.10"]