mirror of
https://github.com/metosin/reitit.git
synced 2025-12-17 16:31:11 +00:00
66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
# Static Resources (Clojure Only)
|
|
|
|
Static resources can be served using `reitit.ring/create-resource-handler`. It takes optionally an options map and returns a ring handler to serve files from Classpath.
|
|
|
|
There are two options to serve the files.
|
|
|
|
## Internal routes
|
|
|
|
This is good option if static files can be from non-conflicting paths, e.g. `"/assets/*"`.
|
|
|
|
```clj
|
|
(require '[reitit.ring :as ring])
|
|
|
|
(ring/ring-handler
|
|
(ring/router
|
|
[["/ping" (constantly {:status 200, :body "pong"})]
|
|
["/assets/*" (ring/create-resource-handler)]])
|
|
(ring/create-default-handler))
|
|
```
|
|
|
|
To serve static files with conflicting routes, e.g. `"/*"`, one needs to disable the conflict resolution:
|
|
|
|
```clj
|
|
(require '[reitit.ring :as ring])
|
|
|
|
(ring/ring-handler
|
|
(ring/router
|
|
[["/ping" (constantly {:status 200, :body "pong"})]
|
|
["/*" (ring/create-resource-handler)]]
|
|
{:conflicts (constantly nil)})
|
|
(ring/create-default-handler))
|
|
```
|
|
|
|
## External routes
|
|
|
|
A better way to serve files from conflicting paths, e.g. `"/*"`, is to serve them from the default-handler. One can compose multiple default locations using `ring-handler`. This way, they are only served if none of the actual routes have matched.
|
|
|
|
```clj
|
|
(ring/ring-handler
|
|
(ring/router
|
|
["/ping" (constantly {:status 200, :body "pong"})])
|
|
(ring/routes
|
|
(ring/create-resource-handler {:path "/"})
|
|
(ring/create-default-handler)))
|
|
```
|
|
|
|
## Configuration
|
|
|
|
`reitit.ring/create-resource-handler` takes 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 | 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\"]`
|
|
| :not-found-handler | optional handler function to use if the requested resource is missing (404 Not Found)
|
|
|
|
|
|
|
|
### TODO
|
|
|
|
* support for things like `:cache`, `:etag`, `:last-modified?`, and `:gzip`
|
|
* support for ClojureScript
|
|
* serve from file-system
|