tupelo.pedestal — io.tupelo/pedestal 21.09.08

Utils for Pedestal

Context clj

Plumatic Schema definition of a Pedestal Context

context-keys-base clj

context? clj

(context? map-in)

Inputs: [map-in :- tsk/KeyMap] Returns: s/Bool

Returns true if the map arg is a Pedestal context map

ctx-trim clj

(ctx-trim ctx)

Inputs: [ctx :- tsk/KeyMap] Returns: tsk/KeyMap

Removes seldom-used keys from interceptor-chain context map to declutter debug printouts (:queue, :stack, :terminators).

ctx-trim-enable clj

Flag to control automatic trimming of interceptor-chain control information.

default-service-map clj

Default options for configuring a Pedestal service

definterceptor clj macro

(definterceptor name ctx)

Creates a Pedestal interceptor given a name and a map like (definterceptor my-intc { :enter <enter-fn> :leave <leave-fn> :error <error-fn> } )

interceptor? clj

(interceptor? map-in)

Inputs: [map-in :- tsk/KeyMap] Returns: s/Bool

Returns true if the map arg is a Pedestal interceptor map

invoke-interceptors clj

(invoke-interceptors ctx interceptors)

Inputs: [ctx :- tsk/KeyMap interceptors :- [tsk/KeyMap]]

Given a context and a vector of interceptor-maps, invokes the interceptor chain and returns the resulting output context.

not-found clj

(not-found)

Returns response for status=Not Found: {:status 404 :body 'Not found '}

ok clj

(ok body)

Wraps response for status=OK as: {:status 200 :body body}

Request clj

Plumatic Schema definition of a Pedestal Request

request-keys-base clj

request? clj

(request? map-in)

Inputs: [map-in :- tsk/KeyMap] Returns: s/Bool

Returns true if the map arg is a Pedestal request map

server-config! clj

(server-config!)

(server-config! server-opts)

Inputs: ([] [server-opts :- tsk/KeyMap])

server-restart! clj

(server-restart!)

Stops and restarts the Jetty HTTP server for a Pedestal service

server-start! clj

(server-start!)

Starts the Jetty HTTP server for a Pedestal service as configured via define-service

server-stop! clj

(server-stop!)

Stops the Jetty HTTP server.

service-delete clj

(service-delete & args)

Given that a Pedestal service has been defined, return the response for an HTTP DELETE request. Does not require a running Jetty server.

service-fn clj

(service-fn)

Returns the service-function (which can be used for testing via pedestal.test/response-for)

service-get clj

(service-get & args)

Given that a Pedestal service has been defined, return the response for an HTTP GET request. Does not require a running Jetty server.

service-post clj

(service-post & args)

Given that a Pedestal service has been defined, return the response for an HTTP POST request. Does not require a running Jetty server.

table-route clj

(table-route route-map)

Inputs: [route-map :- TableRouteInfo] Returns: tsk/Tuple

Creates a Pedestal table-route entry from a context map.

TableRouteInfo clj

Plumatic Schema definition of a Pedestal TableRouteInfo

with-server clj macro

(with-server service-map & forms)

Start & stop the server, even if exception occurs.

with-service clj macro

(with-service service-map & forms)

Run the forms in the context of a Pedestal service definition