reitit

A fast data-driven router for Clojure(Script).

Simple data-driven route syntax
Route conflict resolution
First-class route data
Bi-directional routing
Pluggable coercion (schema & clojure.spec)
Helpers for ring, http, pedestal & frontend
Friendly Error Messages
Extendable
Modular
Fast

Presentations:

Full Documentation

There is #reitit in Clojurians Slack for discussion & help.

Main Modules

reitit - all bundled
reitit-core - the routing core
reitit-ring - a ring router
reitit-middleware - common middleware
reitit-spec clojure.spec coercion
reitit-schema Schema coercion
reitit-swagger Swagger2 apidocs
reitit-swagger-ui Integrated Swagger UI
reitit-frontend Tools for frontend routing
reitit-http http-routing with Interceptors
reitit-interceptors - common interceptors
reitit-sieppari support for Sieppari
reitit-dev - development utilities

Extra modules

reitit-pedestal support for Pedestal

Latest version

All main modules bundled:

[metosin/reitit "0.3.7"]

Optionally, the parts can be required separately.

Quick start

(require '[reitit.core :as r])

(def router
  (r/router
    [["/api/ping" ::ping]
     ["/api/orders/:id" ::order]]))

(r/match-by-path router "/api/ping")
; #Match{:template "/api/ping"
;        :data {:name ::ping}
;        :result nil
;        :path-params {}
;        :path "/api/ping"}

(r/match-by-name router ::order {:id 2})
; #Match{:template "/api/orders/:id",
;        :data {:name ::order},
;        :result nil,
;        :path-params {:id 2},
;        :path "/api/orders/2"}

Ring example

A Ring routing app with input & output coercion using data-specs.

(require '[reitit.ring :as ring])
(require '[reitit.coercion.spec])
(require '[reitit.ring.coercion :as rrc])

(def app
  (ring/ring-handler
    (ring/router
      ["/api"
       ["/math" {:get {:parameters {:query {:x int?, :y int?}}
                       :responses {200 {:body {:total pos-int?}}}
                       :handler (fn [{{{:keys [x y]} :query} :parameters}]
                                  {:status 200
                                   :body {:total (+ x y)}})}}]]
      ;; router data effecting all routes
      {:data {:coercion reitit.coercion.spec/coercion
              :middleware [rrc/coerce-exceptions-middleware
                           rrc/coerce-request-middleware
                           rrc/coerce-response-middleware]}})))

Valid request:

(app {:request-method :get
      :uri "/api/math"
      :query-params {:x "1", :y "2"}})
; {:status 200
;  :body {:total 3}}

Invalid request:

(app {:request-method :get
      :uri "/api/math"
      :query-params {:x "1", :y "a"}})
;{:status 400,
; :body {:type :reitit.coercion/request-coercion,
;        :coercion :spec,
;        :spec "(spec-tools.core/spec {:spec (clojure.spec.alpha/keys :req-un [:$spec20745/x :$spec20745/y]), :type :map, :keys #{:y :x}, :keys/req #{:y :x}})",
;        :problems [{:path [:y],
;                    :pred "clojure.core/int?",
;                    :val "a",
;                    :via [:$spec20745/y],
;                    :in [:y]}],
;        :value {:x "1", :y "a"},
;        :in [:request :query-params]}}

More examples

All examples are in https://github.com/metosin/reitit/tree/master/examples

More info

Check out the full documentation!

Join #reitit channel in Clojurians slack.

Roadmap is mostly written in issues.

Special thanks

Existing Clojure(Script) routing libs, especially to Ataraxy, Bide, Bidi, calfpath, Compojure, Keechma and Pedestal.
Compojure-api, Kekkonen, Ring-swagger and Yada and for ideas, coercion & stuff.
Schema and clojure.spec for the validation part.
httprouter for ideas and a good library to benchmark against

License

Distributed under the Eclipse Public License, the same as Clojure.

livtanong/reitit