mirror of
https://github.com/metosin/reitit.git
synced 2025-12-16 16:01:11 +00:00
0.2.0-alpha1
This commit is contained in:
Tommi Reiman
parent
48504bf71e
commit
2c51f051de
24 changed files with 60 additions and 60 deletions
22
README.md
22
README.md
|
|
@ -42,32 +42,32 @@ Bubblin' under:
|
|||
All bundled:
|
||||
|
||||
```clj
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
Optionally, the parts can be required separately:
|
||||
|
||||
```clj
|
||||
[metosin/reitit-core "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-core "0.2.0-alpha1"]
|
||||
|
||||
;; coercion
|
||||
[metosin/reitit-spec "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-spec "0.2.0-alpha1"]
|
||||
[metosin/reitit-schema "0.2.0-alpha1"]
|
||||
|
||||
;; ring helpers
|
||||
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.2.0-alpha1"]
|
||||
[metosin/reitit-middleware "0.2.0-alpha1"]
|
||||
|
||||
;; swagger-support for ring & http
|
||||
[metosin/reitit-swagger "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.2.0-alpha1"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-alpha1"]
|
||||
|
||||
;; frontend helpers (alpha)
|
||||
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.2.0-alpha1"]
|
||||
|
||||
;; http with interceptors (alpha)
|
||||
[metosin/reitit-http "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-sieppari "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-http "0.2.0-alpha1"]
|
||||
[metosin/reitit-sieppari "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
## Quick start
|
||||
|
|
|
|||
|
|
@ -34,32 +34,32 @@ Bubblin' under:
|
|||
All bundled:
|
||||
|
||||
```clj
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
Optionally, the parts can be required separately:
|
||||
|
||||
```clj
|
||||
[metosin/reitit-core "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-core "0.2.0-alpha1"]
|
||||
|
||||
;; coercion
|
||||
[metosin/reitit-spec "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-spec "0.2.0-alpha1"]
|
||||
[metosin/reitit-schema "0.2.0-alpha1"]
|
||||
|
||||
;; ring helpers
|
||||
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.2.0-alpha1"]
|
||||
[metosin/reitit-middleware "0.2.0-alpha1"]
|
||||
|
||||
;; swagger-support for ring & http
|
||||
[metosin/reitit-swagger "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.2.0-alpha1"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-alpha1"]
|
||||
|
||||
;; frontend helpers (alpha)
|
||||
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.2.0-alpha1"]
|
||||
|
||||
;; http with interceptors (alpha)
|
||||
[metosin/reitit-http "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-sieppari "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-http "0.2.0-alpha1"]
|
||||
[metosin/reitit-sieppari "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians Slack](http://clojurians.net/) for discussion & help.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Default Middleware
|
||||
|
||||
```clj
|
||||
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-middleware "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
Any Ring middleware can be used with `reitit-ring`, but using data-driven middleware is preferred as they are easier to manage and in many cases, yield better performance. `reitit-middleware` contains a set of common ring middleware, lifted into data-driven middleware.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
[Ring](https://github.com/ring-clojure/ring) is a Clojure web applications library inspired by Python's WSGI and Ruby's Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows web applications to be constructed of modular components that can be shared among a variety of applications, web servers, and web frameworks.
|
||||
|
||||
```clj
|
||||
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
Ring-router adds support for [handlers](https://github.com/ring-clojure/ring/wiki/Concepts#handlers), [middleware](https://github.com/ring-clojure/ring/wiki/Concepts#middleware) and routing based on `:request-method`. Ring-router is created with `reitit.ring/router` function. It uses a custom route compiler, creating a optimized data structure for handling route matches, with compiled middleware chain & handlers for all request methods. It also ensures that all routes have a `:handler` defined. `reitit.ring/ring-handler` is used to create a Ring handler out of ring-router.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Swagger Support
|
||||
|
||||
```
|
||||
[metosin/reitit-swagger "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
Reitit supports [Swagger2](https://swagger.io/) documentation, thanks to [schema-tools](https://github.com/metosin/schema-tools) and [spec-tools](https://github.com/metosin/spec-tools). Documentation is extracted from route definitions, coercion `:parameters` and `:responses` and from a set of new documentation keys.
|
||||
|
|
@ -44,7 +44,7 @@ If you need to post-process the generated spec, just wrap the handler with a cus
|
|||
[Swagger-ui](https://github.com/swagger-api/swagger-ui) is a user interface to visualize and interact with the Swagger specification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module.
|
||||
|
||||
```
|
||||
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-alpha1"]
|
||||
```
|
||||
|
||||
`reitit.swagger-ui/create-swagger-ui-hander` can be used to create a ring-handler to serve the swagger-ui. It accepts the following options:
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@
|
|||
[compojure "1.6.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.10.339"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit "0.2.0-alpha1"]
|
||||
[metosin/reitit-schema "0.2.0-alpha1"]
|
||||
[metosin/reitit-frontend "0.2.0-alpha1"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.12"]]
|
||||
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@
|
|||
[compojure "1.6.1"]
|
||||
[hiccup "1.0.5"]
|
||||
[org.clojure/clojurescript "1.10.339"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit "0.2.0-alpha1"]
|
||||
[metosin/reitit-schema "0.2.0-alpha1"]
|
||||
[metosin/reitit-frontend "0.2.0-alpha1"]
|
||||
;; Just for pretty printting the match
|
||||
[fipp "0.6.12"]]
|
||||
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@
|
|||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[org.clojure/core.async "0.4.474"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]]
|
||||
[metosin/reitit "0.2.0-alpha1"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -3,4 +3,4 @@
|
|||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/muuntaja "0.4.1"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]])
|
||||
[metosin/reitit "0.2.0-alpha1"]])
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@
|
|||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[io.pedestal/pedestal.service "0.5.4"]
|
||||
[io.pedestal/pedestal.jetty "0.5.4"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]]
|
||||
[metosin/reitit "0.2.0-alpha1"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -2,5 +2,5 @@
|
|||
:description "Reitit Ring App"
|
||||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]]
|
||||
[metosin/reitit "0.2.0-alpha1"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -2,5 +2,5 @@
|
|||
:description "Reitit Ring App with Swagger"
|
||||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/reitit "0.2.0-SNAPSHOT"]]
|
||||
[metosin/reitit "0.2.0-alpha1"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-core "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-core "0.2.0-alpha1"
|
||||
:description "Snappy data-driven router for Clojure(Script)"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-frontend "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-frontend "0.2.0-alpha1"
|
||||
:description "Reitit: Clojurescript frontend routing core"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-http "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-http "0.2.0-alpha1"
|
||||
:description "Reitit: HTTP routing with interceptors"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-middleware "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-middleware "0.2.0-alpha1"
|
||||
:description "Reitit, common middleware bundled"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-ring "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-ring "0.2.0-alpha1"
|
||||
:description "Reitit: Ring routing"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-schema "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-schema "0.2.0-alpha1"
|
||||
:description "Reitit: Plumatic Schema coercion"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-sieppari "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-sieppari "0.2.0-alpha1"
|
||||
:description "Reitit: Sieppari Interceptors"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-spec "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-spec "0.2.0-alpha1"
|
||||
:description "Reitit: clojure.spec coercion"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-swagger-ui "0.2.0-alpha1"
|
||||
:description "Reitit: Swagger-ui support"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-swagger "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-swagger "0.2.0-alpha1"
|
||||
:description "Reitit: Swagger-support"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit "0.2.0-alpha1"
|
||||
:description "Snappy data-driven router for Clojure(Script)"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
24
project.clj
24
project.clj
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-parent "0.2.0-SNAPSHOT"
|
||||
(defproject metosin/reitit-parent "0.2.0-alpha1"
|
||||
:description "Snappy data-driven router for Clojure(Script)"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
@ -9,17 +9,17 @@
|
|||
:source-uri "https://github.com/metosin/reitit/{version}/{filepath}#L{line}"
|
||||
:metadata {:doc/format :markdown}}
|
||||
|
||||
:managed-dependencies [[metosin/reitit "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-core "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-spec "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-http "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
|
||||
[metosin/reitit-sieppari "0.2.0-SNAPSHOT"]
|
||||
:managed-dependencies [[metosin/reitit "0.2.0-alpha1"]
|
||||
[metosin/reitit-core "0.2.0-alpha1"]
|
||||
[metosin/reitit-spec "0.2.0-alpha1"]
|
||||
[metosin/reitit-schema "0.2.0-alpha1"]
|
||||
[metosin/reitit-ring "0.2.0-alpha1"]
|
||||
[metosin/reitit-middleware "0.2.0-alpha1"]
|
||||
[metosin/reitit-http "0.2.0-alpha1"]
|
||||
[metosin/reitit-swagger "0.2.0-alpha1"]
|
||||
[metosin/reitit-swagger-ui "0.2.0-alpha1"]
|
||||
[metosin/reitit-frontend "0.2.0-alpha1"]
|
||||
[metosin/reitit-sieppari "0.2.0-alpha1"]
|
||||
[meta-merge "1.0.0"]
|
||||
[ring/ring-core "1.6.3"]
|
||||
[metosin/spec-tools "0.7.1"]
|
||||
|
|
|
|||
Loading…
Reference in a new issue