Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,101 Commits
.clj-kondo		.clj-kondo
.github/workflows		.github/workflows
.lsp		.lsp
dev-resources		dev-resources
doc		doc
examples		examples
modules		modules
perf-test/clj/reitit		perf-test/clj/reitit
scripts		scripts
test		test
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
bb.edn		bb.edn
book.json		book.json
karma.conf.js		karma.conf.js
lint.sh		lint.sh
package-lock.json		package-lock.json
package.json		package.json
project.clj		project.clj
shadow-cljs.edn		shadow-cljs.edn

Repository files navigation

reitit

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

Simple data-drivenroute syntax
Routeconflict resolution
First-classroute data
Bi-directional routing
Pluggable coercion (malli,schema &clojure.spec)
Helpers forring,http,pedestal &frontend
FriendlyError Messages
Extendable
Modular
Fast

Presentations:

Status:stable

Hi! We areMetosin, a consulting company. These libraries have evolved out of the work we do for our clients.We maintain & develop this project, for you, for free. Issues and pull requests welcome!However, if you want more help using the libraries, or want us to build something as cool for you, consider ourcommercial support.

Full Documentation

There is#reitit inClojurians Slack for discussion & help.

Main Modules

metosin/reitit - all bundled
metosin/reitit-core - the routing core
metosin/reitit-ring - aring router
metosin/reitit-middleware -common middleware
metosin/reitit-specclojure.spec coercion
metosin/reitit-mallimalli coercion
metosin/reitit-schemaSchema coercion
fi.metosin/reitit-openapiOpenAPI apidocs *
metosin/reitit-swaggerSwagger2 apidocs
metosin/reitit-swagger-ui IntegratedSwagger UI
metosin/reitit-frontend Tools for frontend routing
metosin/reitit-http http-routing with Interceptors
metosin/reitit-interceptors -common interceptors
metosin/reitit-sieppari support forSieppari
metosin/reitit-dev - development utilities

... * This is not a typo; the newreitit-openapi was released under the new, verifiedfi.metosin group. Existingmodules will continue to be released undermetosin for compatibility purposes.

Extra modules

reitit-pedestal support forPedestal

Latest version

All main modules bundled:

[metosin/reitit"0.9.2"]

Optionally, the parts can be required separately.

Reitit requires Clojure 1.11 and Java 11.

Reitit is tested with the LTS releases Java 11, 17 and 21.

Quick start

(require '[reitit.core:as r])(defrouter  (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 {:id2}); #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 usingdata-specs.

(require '[muuntaja.core:as m])(require '[reitit.ring:as ring])(require '[reitit.coercion.spec])(require '[reitit.ring.coercion:as rrc])(require '[reitit.ring.middleware.exception:as exception])(require '[reitit.ring.middleware.muuntaja:as muuntaja])(require '[reitit.ring.middleware.parameters:as parameters])(defapp  (ring/ring-handler    (ring/router      ["/api"       ["/math" {:get {:parameters {:query {:x int?,:y int?}}:responses  {200 {:body {:total int?}}}:handler    (fn [{{{:keys [x y]}:query}:parameters}]                                     {:status200:body   {:total (+ x y)}})}}]];; router data affecting all routes      {:data {:coercion   reitit.coercion.spec/coercion:muuntaja   m/instance:middleware [parameters/parameters-middleware; decoding query & form params                           muuntaja/format-middleware; content negotiation                           exception/exception-middleware; converting exceptions to HTTP responses                           rrc/coerce-request-middleware                           rrc/coerce-response-middleware]}})))

Valid request:

(-> (app {:request-method:get:uri"/api/math":query-params {:x"1",:y"2"}})    (update:body slurp)); {:status 200;  :body "{\"total\":3}";  :headers {"Content-Type" "application/json; charset=utf-8"}}

Invalid request:

(-> (app {:request-method:get:uri"/api/math":query-params {:x"1",:y"a"}})    (update:body jsonista.core/read-value)); {:status 400;  :headers {"Content-Type" "application/json; charset=utf-8"};  :body {"spec" "(spec-tools.core/spec {:spec (clojure.spec.alpha/keys :req-un [:spec$8974/x :spec$8974/y]), :type :map, :leaf? false})";         "value" {"x" "1";                  "y" "a"};         "problems" [{"via" ["spec$8974/y"];                      "path" ["y"];                      "pred" "clojure.core/int?";                      "in" ["y"];                      "val" "a"}];         "type" "reitit.coercion/request-coercion";         "coercion" "spec";         "in" ["request" "query-params"]}}

More examples

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

External resources

Simple web application using Ring/Reitit and Integrant:https://github.com/PrestanceDesign/usermanager-reitit-integrant-example
A simple Clojure backend using Reitit to serve up a RESTful API:startrek. Technologies include:
https://www.learnreitit.com/
Lipas, liikuntapalvelut:https://github.com/lipas-liikuntapaikat/lipas
Implementation of the Todo-Backend API spec, using Clojure, Ring/Reitit and next-jdbc:https://github.com/PrestanceDesign/todo-backend-clojure-reitit
Ping CRM, a single page app written in Clojure Ring, Reitit, Integrant and next.jdbc:https://github.com/prestancedesign/clojure-inertia-pingcrm-demo

More info

Check out the full documentation!

Join#reitit channel inClojurians slack.

Roadmap is mostly written inissues.

Special thanks

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