luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-17 00:11:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

0.2.0-SNAPSHOT

Browse source
This commit is contained in:
Tommi Reiman 2018-07-28 12:07:16 +03:00
parent 23e79e2688
commit bb4f861f00
19 changed files with 44 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -1,4 +1,4 @@
## UNRELEASED
## 0.2.0-SNAPSHOT
## `reitit-core`

14
README.md
View file

@ -36,18 +36,18 @@ Bubblin' under:
All bundled:
```clj
[metosin/reitit "0.1.4-SNAPSHOT"]
[metosin/reitit "0.2.0-SNAPSHOT"]
```
Optionally, the parts can be required separately:
```clj
[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-core "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-spec "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
```
## Quick start

14
doc/README.md
View file

@ -25,18 +25,18 @@ Modules:
To use Reitit, add the following dependency to your project:
```clj
[metosin/reitit "0.1.4-SNAPSHOT"]
[metosin/reitit "0.2.0-SNAPSHOT"]
```
Optionally, the parts can be required separately:
```clj
[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-core "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-spec "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
[metosin/frontend "0.1.4-SNAPSHOT"]
```

2
doc/ring/ring.md
View file

@ -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.4-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-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.

4
doc/ring/swagger.md
View file

@ -1,7 +1,7 @@
# Swagger Support
```
[metosin/reitit-swagger "0.1.4-SNAPSHOT"]
[metosin/reitit-swagger "0.2.0-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.4-SNAPSHOT"]
[metosin/reitit-swagger-ui "0.2.0-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:

6
examples/frontend-controllers/project.clj
View file

@ -11,9 +11,9 @@
[compojure "1.6.1"]
[hiccup "1.0.5"]
[org.clojure/clojurescript "1.10.339"]
[metosin/reitit "0.1.4-SNAPSHOT"]
[metosin/reitit-schema "0.1.4-SNAPSHOT"]
[metosin/reitit-frontend "0.1.4-SNAPSHOT"]
[metosin/reitit "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
;; Just for pretty printting the match
[fipp "0.6.12"]]

6
examples/frontend/project.clj
View file

@ -11,9 +11,9 @@
[compojure "1.6.1"]
[hiccup "1.0.5"]
[org.clojure/clojurescript "1.10.339"]
[metosin/reitit "0.1.4-SNAPSHOT"]
[metosin/reitit-schema "0.1.4-SNAPSHOT"]
[metosin/reitit-frontend "0.1.4-SNAPSHOT"]
[metosin/reitit "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"]
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
;; Just for pretty printting the match
[fipp "0.6.12"]]

2
examples/just-coercion-with-ring/project.clj
View file

@ -3,4 +3,4 @@
:dependencies [[org.clojure/clojure "1.9.0"]
[ring "1.6.3"]
[metosin/muuntaja "0.4.1"]
[metosin/reitit "0.1.4-SNAPSHOT"]])
[metosin/reitit "0.2.0-SNAPSHOT"]])

2
examples/ring-example/project.clj
View file

@ -3,4 +3,4 @@
:dependencies [[org.clojure/clojure "1.9.0"]
[ring "1.6.3"]
[metosin/muuntaja "0.4.1"]
[metosin/reitit "0.1.4-SNAPSHOT"]])
[metosin/reitit "0.2.0-SNAPSHOT"]])

2
examples/ring-swagger/project.clj
View file

@ -3,5 +3,5 @@
:dependencies [[org.clojure/clojure "1.9.0"]
[ring "1.6.3"]
[metosin/muuntaja "0.5.0"]
[metosin/reitit "0.1.4-SNAPSHOT"]]
[metosin/reitit "0.2.0-SNAPSHOT"]]
:repl-options {:init-ns example.server})

2
modules/reitit-core/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-core "0.1.4-SNAPSHOT"
(defproject metosin/reitit-core "0.2.0-SNAPSHOT"
:description "Snappy data-driven router for Clojure(Script)"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit-frontend/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-frontend "0.1.4-SNAPSHOT"
(defproject metosin/reitit-frontend "0.2.0-SNAPSHOT"
:description "Reitit: Clojurescript frontend routing core"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit-ring/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-ring "0.1.4-SNAPSHOT"
(defproject metosin/reitit-ring "0.2.0-SNAPSHOT"
:description "Reitit: Ring routing"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit-schema/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-schema "0.1.4-SNAPSHOT"
(defproject metosin/reitit-schema "0.2.0-SNAPSHOT"
:description "Reitit: Plumatic Schema coercion"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit-spec/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-spec "0.1.4-SNAPSHOT"
(defproject metosin/reitit-spec "0.2.0-SNAPSHOT"
:description "Reitit: clojure.spec coercion"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit-swagger-ui/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"
(defproject metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"
:description "Reitit: Swagger-ui support"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit-swagger/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-swagger "0.1.4-SNAPSHOT"
(defproject metosin/reitit-swagger "0.2.0-SNAPSHOT"
:description "Reitit: Swagger-support"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

2
modules/reitit/project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit "0.1.4-SNAPSHOT"
(defproject metosin/reitit "0.2.0-SNAPSHOT"
:description "Snappy data-driven router for Clojure(Script)"
:url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License"

18
project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-parent "0.1.4-SNAPSHOT"
(defproject metosin/reitit-parent "0.2.0-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.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"]
:managed-dependencies [[metosin/reitit "0.2.0-SNAPSHOT"]
[metosin/reitit-core "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-spec "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "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"]
[meta-merge "1.0.0"]
[ring/ring-core "1.6.3"]