mirror of
https://github.com/metosin/reitit.git
synced 2026-01-10 17:19:50 +00:00
Start version 0.1.4
This commit is contained in:
Juho Teperi
parent
06b641398a
commit
264981fd3d
17 changed files with 40 additions and 40 deletions
14
README.md
14
README.md
|
|
@ -36,18 +36,18 @@ Bubblin' under:
|
|||
All bundled:
|
||||
|
||||
```clj
|
||||
[metosin/reitit "0.1.3"]
|
||||
[metosin/reitit "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
Optionally, the parts can be required separately:
|
||||
|
||||
```clj
|
||||
[metosin/reitit-core "0.1.3"]
|
||||
[metosin/reitit-ring "0.1.3"]
|
||||
[metosin/reitit-spec "0.1.3"]
|
||||
[metosin/reitit-schema "0.1.3"]
|
||||
[metosin/reitit-swagger "0.1.3"]
|
||||
[metosin/reitit-swagger-ui "0.1.3"]
|
||||
[metosin/reitit-core "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-spec "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
## Quick start
|
||||
|
|
|
|||
|
|
@ -23,18 +23,18 @@ Modules:
|
|||
To use Reitit, add the following dependecy to your project:
|
||||
|
||||
```clj
|
||||
[metosin/reitit "0.1.3"]
|
||||
[metosin/reitit "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
Optionally, the parts can be required separately:
|
||||
|
||||
```clj
|
||||
[metosin/reitit-core "0.1.3"]
|
||||
[metosin/reitit-ring "0.1.3"]
|
||||
[metosin/reitit-spec "0.1.3"]
|
||||
[metosin/reitit-schema "0.1.3"]
|
||||
[metosin/reitit-swagger "0.1.3"]
|
||||
[metosin/reitit-swagger-ui "0.1.3"]
|
||||
[metosin/reitit-core "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-spec "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/).
|
||||
|
|
|
|||
|
|
@ -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.1.3"]
|
||||
[metosin/reitit-ring "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
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.1.3"]
|
||||
[metosin/reitit-swagger "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
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.1.3"]
|
||||
[metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"]
|
||||
```
|
||||
|
||||
`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.238" :scope "provided"]
|
||||
[metosin/reitit "0.1.3"]
|
||||
[metosin/reitit-schema "0.1.3"]
|
||||
[metosin/reitit-frontend "0.1.3"]]
|
||||
[metosin/reitit "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.1.4-SNAPSHOT"]]
|
||||
|
||||
:plugins [[lein-cljsbuild "1.1.7"]]
|
||||
|
||||
|
|
|
|||
|
|
@ -3,4 +3,4 @@
|
|||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/muuntaja "0.4.1"]
|
||||
[metosin/reitit "0.1.3"]])
|
||||
[metosin/reitit "0.1.4-SNAPSHOT"]])
|
||||
|
|
|
|||
|
|
@ -3,4 +3,4 @@
|
|||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/muuntaja "0.4.1"]
|
||||
[metosin/reitit "0.1.3"]])
|
||||
[metosin/reitit "0.1.4-SNAPSHOT"]])
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@
|
|||
:dependencies [[org.clojure/clojure "1.9.0"]
|
||||
[ring "1.6.3"]
|
||||
[metosin/muuntaja "0.5.0"]
|
||||
[metosin/reitit "0.1.3"]]
|
||||
[metosin/reitit "0.1.4-SNAPSHOT"]]
|
||||
:repl-options {:init-ns example.server})
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-core "0.1.3"
|
||||
(defproject metosin/reitit-core "0.1.4-SNAPSHOT"
|
||||
: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.1.3"
|
||||
(defproject metosin/reitit-frontend "0.1.4-SNAPSHOT"
|
||||
:description "Reitit: Clojurescript frontend routing core"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-ring "0.1.3"
|
||||
(defproject metosin/reitit-ring "0.1.4-SNAPSHOT"
|
||||
:description "Reitit: Ring routing"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-schema "0.1.3"
|
||||
(defproject metosin/reitit-schema "0.1.4-SNAPSHOT"
|
||||
:description "Reitit: Plumatic Schema coercion"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-spec "0.1.3"
|
||||
(defproject metosin/reitit-spec "0.1.4-SNAPSHOT"
|
||||
: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.1.3"
|
||||
(defproject metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"
|
||||
: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.1.3"
|
||||
(defproject metosin/reitit-swagger "0.1.4-SNAPSHOT"
|
||||
:description "Reitit: Swagger-support"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit "0.1.3"
|
||||
(defproject metosin/reitit "0.1.4-SNAPSHOT"
|
||||
:description "Snappy data-driven router for Clojure(Script)"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
|
|||
18
project.clj
18
project.clj
|
|
@ -1,4 +1,4 @@
|
|||
(defproject metosin/reitit-parent "0.1.3"
|
||||
(defproject metosin/reitit-parent "0.1.4-SNAPSHOT"
|
||||
:description "Snappy data-driven router for Clojure(Script)"
|
||||
:url "https://github.com/metosin/reitit"
|
||||
:license {:name "Eclipse Public License"
|
||||
|
|
@ -9,14 +9,14 @@
|
|||
:source-uri "https://github.com/metosin/reitit/{version}/{filepath}#L{line}"
|
||||
:metadata {:doc/format :markdown}}
|
||||
|
||||
:managed-dependencies [[metosin/reitit "0.1.3"]
|
||||
[metosin/reitit-core "0.1.3"]
|
||||
[metosin/reitit-ring "0.1.3"]
|
||||
[metosin/reitit-spec "0.1.3"]
|
||||
[metosin/reitit-schema "0.1.3"]
|
||||
[metosin/reitit-swagger "0.1.3"]
|
||||
[metosin/reitit-swagger-ui "0.1.3"]
|
||||
[metosin/reitit-frontend "0.1.3"]
|
||||
:managed-dependencies [[metosin/reitit "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-core "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-ring "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-spec "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-schema "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-swagger "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"]
|
||||
[metosin/reitit-frontend "0.1.4-SNAPSHOT"]
|
||||
|
||||
[meta-merge "1.0.0"]
|
||||
[ring/ring-core "1.6.3"]
|
||||
|
|
|
|||
Loading…
Reference in a new issue