compojure.core

A DSL for building Ring handlers from smaller routes.

Compojure routes are semantically the same as Ring handlers, with the exception that routes may return nil to indicate they do not match.

This namespace provides functions and macros for concisely constructing routes and combining them together to form more complex functions.

ANY

macro

(ANY path args & body)

Generate a route that matches any method.

compile-route

(compile-route method path bindings body)

Compile a route in the form (method path bindings & body) into a function. Used to create custom route macros.

context

macro

(context path args & routes)

Give all routes in the form a common path prefix and set of bindings.

The following example demonstrates defining two routes with a common path prefix (‘/user/:id’) and a common binding (‘id’):

(context "/user/:id" [id]
  (GET "/profile" [] ...)
  (GET "/settings" [] ...))

defroutes

macro

(defroutes name & routes)

Define a Ring handler function from a sequence of routes. The name may optionally be followed by a doc-string and metadata map.

DELETE

macro

(DELETE path args & body)

Generate a DELETE route.

GET

macro

(GET path args & body)

Generate a GET route.

HEAD

macro

(HEAD path args & body)

Generate a HEAD route.

let-routes

macro

(let-routes bindings & body)

Takes a vector of bindings and a body of routes.

Equivalent to:

(let [...] (routes ...))

make-route

(make-route method path handler)

Returns a function that will only call the handler if the method and path match the request.

OPTIONS

macro

(OPTIONS path args & body)

Generate an OPTIONS route.

PATCH

macro

(PATCH path args & body)

Generate a PATCH route.

POST

macro

(POST path args & body)

Generate a POST route.

PUT

macro

(PUT path args & body)

Generate a PUT route.

rfn

macro

(rfn args & body)

Generate a route that matches any method and path.

routes

(routes & handlers)

Create a Ring handler by combining several handlers into one.

routing

(routing request & handlers)

Apply a list of routes to a Ring request map.

wrap-routes

(wrap-routes handler middleware)(wrap-routes handler middleware & args)

Apply a middleware function to routes after they have been matched.