Liking cljdoc? Tell your friends :D

reitit.http


coerce-handler

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

compile-result

(compile-result [path data]
                {:keys [:reitit.http/default-options-handler],
                 :as opts})
source

Endpoint

source

get-match

(get-match request)
source

get-router

(get-router handler)
source

ring-handler

(ring-handler router opts)
(ring-handler router
              default-handler
              {:keys [executor interceptors inject-match?
                      inject-router?],
               :or {inject-match? true, inject-router? true}})

Creates a ring-handler out of a http-router, optional default ring-handler and options map, with the following keys:

keydescription
:executorreitit.interceptor.Executor for the interceptor chain
:interceptorsOptional sequence of interceptors that are always run before any other interceptors, even for the default handler
:inject-match?Boolean to inject match into request under :reitit.core/match key (default true)
:inject-router?Boolean to inject router into request under :reitit.core/router key (default true)
Creates a ring-handler out of a http-router, optional default ring-handler
and options map, with the following keys:

| key               | description |
| ------------------|-------------|
| `:executor`       | `reitit.interceptor.Executor` for the interceptor chain
| `:interceptors`   | Optional sequence of interceptors that are always run before any other interceptors, even for the default handler
| `:inject-match?`  | Boolean to inject `match` into request under `:reitit.core/match` key (default true)
| `:inject-router?` | Boolean to inject `router` into request under `:reitit.core/router` key (default true)
sourceraw docstring

router

(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 Interceptors. See documentation on reitit.core/router for available options. In addition, the following options are available:

keydescription
:reitit.interceptor/transformFunction or vector of functions of type [Interceptor] => [Interceptor] to transform the expanded Interceptors (default: identity)
:reitit.interceptor/registryMap of keyword => IntoInterceptor to replace keyword references into Interceptors
:reitit.http/default-options-handlerDefault handler for :options method in endpoints (default: reitit.ring/default-options-handler)

Example:

(router
  ["/api" {:interceptors [format-i oauth2-i]}
    ["/users" {:get get-user
                 :post update-user
                 :delete {:interceptors [delete-i]
                         :handler delete-user}}]])
Creates a [[reitit.core/Router]] from raw route data and optionally an options map with
support for http-methods and Interceptors. See documentation on [[reitit.core/router]]
for available options. In addition, the following options are available:

| key                                    | description
| ---------------------------------------|-------------
| `:reitit.interceptor/transform`        | Function or vector of functions of type `[Interceptor] => [Interceptor]` to transform the expanded Interceptors (default: identity)
| `:reitit.interceptor/registry`         | Map of `keyword => IntoInterceptor` to replace keyword references into Interceptors
| `:reitit.http/default-options-handler` | Default handler for `:options` method in endpoints (default: reitit.ring/default-options-handler)

Example:

    (router
      ["/api" {:interceptors [format-i oauth2-i]}
        ["/users" {:get get-user
                     :post update-user
                     :delete {:interceptors [delete-i]
                             :handler delete-user}}]])
sourceraw docstring

routing-interceptor

(routing-interceptor router
                     default-handler
                     {:keys [interceptors executor inject-match?
                             inject-router?],
                      :or {inject-match? true, inject-router? true}})

Creates a Pedestal-style routing interceptor that enqueues the interceptors into context. Takes http-router, default ring-handler and and options map, with the following keys:

keydescription
:executorreitit.interceptor.Executor for the interceptor chain
:interceptorsOptional sequence of interceptors that are always run before any other interceptors, even for the default handler
:inject-match?Boolean to inject match into request under :reitit.core/match key (default true)
:inject-router?Boolean to inject router into request under :reitit.core/router key (default true)
Creates a Pedestal-style routing interceptor that enqueues the interceptors into context.
Takes http-router, default ring-handler and and options map, with the following keys:

| key               | description |
| ------------------|-------------|
| `:executor`       | `reitit.interceptor.Executor` for the interceptor chain
| `:interceptors`   | Optional sequence of interceptors that are always run before any other interceptors, even for the default handler
| `:inject-match?`  | Boolean to inject `match` into request under `:reitit.core/match` key (default true)
| `:inject-router?` | Boolean to inject `router` into request under `:reitit.core/router` key (default true)
sourceraw docstring

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

× close