Liking cljdoc? Tell your friends :D

reitit.ring


coerce-handlerclj/s

(coerce-handler [path data] {:keys [expand] :as opts})

compile-resultclj/s

(compile-result [path data] opts)

create-default-handlerclj/s

(create-default-handler)
(create-default-handler {:keys [not-found method-not-allowed not-acceptable]})

A default ring handler that can handle the following cases, configured via options:

keydescription
:not-found404, no routes matches
:method-not-accepted405, no method matches
:not-acceptable406, handler returned nil
A default ring handler that can handle the following cases,
configured via options:

| key                    | description |
| -----------------------|-------------|
| `:not-found`           | 404, no routes matches
| `:method-not-accepted` | 405, no method matches
| `:not-acceptable`      | 406, handler returned `nil`
raw docstring

create-resource-handlerclj

(create-resource-handler)
(create-resource-handler {:keys [parameter root path loader allow-symlinks?
                                 index-files paths]
                          :or {parameter (keyword "")
                               root "public"
                               index-files ["index.html"]
                               paths (constantly nil)}})

A ring handler for serving classpath resources, configured via options:

keydescription
:parameteroptional name of the wildcard parameter, defaults to unnamed keyword :
:rootoptional resource root, defaults to "public"
:pathoptional path to mount the handler to. Works only if mounted outside of a router.
:loaderoptional class loader to resolve the resources
:index-filesoptional vector of index-files to look in a resource directory, defaults to ["index.html"]
A ring handler for serving classpath resources, configured via options:

| 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"]`
raw docstring

Endpointcljs


get-matchclj/s

(get-match request)

get-routerclj/s

(get-router handler)

group-keysclj/s

(group-keys data)

http-methodsclj/s


Methodscljs


ring-handlerclj/s

(ring-handler router)
(ring-handler router default-handler)

Creates a ring-handler out of a ring-router. Supports both 1 (sync) and 3 (async) arities. Optionally takes a ring-handler which is called in no route matches.

Creates a ring-handler out of a ring-router.
Supports both 1 (sync) and 3 (async) arities.
Optionally takes a ring-handler which is called
in no route matches.
raw docstring

routerclj/s

(router data)
(router data opts)

Creates a [[reitit.core/Router]] from raw route data and optionally an options map with support for http-methods and Middleware. See docs for details.

Example:

(router
  ["/api" {:middleware [wrap-format wrap-oauth2]}
    ["/users" {:get get-user
                 :post update-user
                 :delete {:middleware [wrap-delete]
                         :handler delete-user}}]])

See router options from [[reitit.core/router]] and [[reitit.middleware/router]].

Creates a [[reitit.core/Router]] from raw route data and optionally an options map with
support for http-methods and Middleware. See [docs](https://metosin.github.io/reitit/)
for details.

Example:

    (router
      ["/api" {:middleware [wrap-format wrap-oauth2]}
        ["/users" {:get get-user
                     :post update-user
                     :delete {:middleware [wrap-delete]
                             :handler delete-user}}]])

See router options from [[reitit.core/router]] and [[reitit.middleware/router]].
raw docstring

routesclj/s

(routes & handlers)

Create a ring handler by combining several handlers into one.

Create a ring handler by combining several handlers into one.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close