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.1.1

Browse source
This commit is contained in:
Tommi Reiman 2018-05-20 21:55:46 +03:00
parent 3b15261b4d
commit fc71947bbb
16 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -1,4 +1,4 @@
## 0.1.1-SNAPSHOT ## 0.1.1 (2018-5-20)
### `reitit-core` ### `reitit-core`

14
README.md
View file

@ -36,18 +36,18 @@ See the [full documentation](https://metosin.github.io/reitit/) for details.
All bundled: All bundled:
```clj ```clj
[metosin/reitit "0.1.1-SNAPSHOT"] [metosin/reitit "0.1.1"]
``` ```
Optionally, the parts can be required separately: Optionally, the parts can be required separately:
```clj ```clj
[metosin/reitit-core "0.1.1-SNAPSHOT"] [metosin/reitit-core "0.1.1"]
[metosin/reitit-ring "0.1.1-SNAPSHOT"] [metosin/reitit-ring "0.1.1"]
[metosin/reitit-spec "0.1.1-SNAPSHOT"] [metosin/reitit-spec "0.1.1"]
[metosin/reitit-schema "0.1.1-SNAPSHOT"] [metosin/reitit-schema "0.1.1"]
[metosin/reitit-swagger "0.1.1-SNAPSHOT"] [metosin/reitit-swagger "0.1.1"]
[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] [metosin/reitit-swagger-ui "0.1.1"]
``` ```
## Quick start ## Quick start

14
doc/README.md
View file

@ -23,18 +23,18 @@ Modules:
To use Reitit, add the following dependecy to your project: To use Reitit, add the following dependecy to your project:
```clj ```clj
[metosin/reitit "0.1.1-SNAPSHOT"] [metosin/reitit "0.1.1"]
``` ```
Optionally, the parts can be required separately: Optionally, the parts can be required separately:
```clj ```clj
[metosin/reitit-core "0.1.1-SNAPSHOT"] [metosin/reitit-core "0.1.1"]
[metosin/reitit-ring "0.1.1-SNAPSHOT"] [metosin/reitit-ring "0.1.1"]
[metosin/reitit-spec "0.1.1-SNAPSHOT"] [metosin/reitit-spec "0.1.1"]
[metosin/reitit-schema "0.1.1-SNAPSHOT"] [metosin/reitit-schema "0.1.1"]
[metosin/reitit-swagger "0.1.1-SNAPSHOT"] [metosin/reitit-swagger "0.1.1"]
[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] [metosin/reitit-swagger-ui "0.1.1"]
``` ```
For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/). For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/).

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. [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 ```clj
[metosin/reitit-ring "0.1.1-SNAPSHOT"] [metosin/reitit-ring "0.1.1"]
``` ```
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. 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 # Swagger Support
``` ```
[metosin/reitit-swagger "0.1.1-SNAPSHOT"] [metosin/reitit-swagger "0.1.1"]
``` ```
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. 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 spesification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module. [Swagger-ui](https://github.com/swagger-api/swagger-ui) is a user interface to visualize and interact with the Swagger spesification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module.
``` ```
[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] [metosin/reitit-swagger-ui "0.1.1"]
``` ```
`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: `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:

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -1,4 +1,4 @@
(defproject metosin/reitit-spec "0.1.1-SNAPSHOT" (defproject metosin/reitit-spec "0.1.1"
:description "Reitit: clojure.spec coercion" :description "Reitit: clojure.spec coercion"
:url "https://github.com/metosin/reitit" :url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License" :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.1-SNAPSHOT" (defproject metosin/reitit-swagger-ui "0.1.1"
:description "Reitit: Swagger-ui support" :description "Reitit: Swagger-ui support"
:url "https://github.com/metosin/reitit" :url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License" :license {:name "Eclipse Public License"

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

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

2
modules/reitit/project.clj
View file

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

16
project.clj
View file

@ -1,4 +1,4 @@
(defproject metosin/reitit-parent "0.1.1-SNAPSHOT" (defproject metosin/reitit-parent "0.1.1"
:description "Snappy data-driven router for Clojure(Script)" :description "Snappy data-driven router for Clojure(Script)"
:url "https://github.com/metosin/reitit" :url "https://github.com/metosin/reitit"
:license {:name "Eclipse Public License" :license {:name "Eclipse Public License"
@ -9,13 +9,13 @@
:source-uri "https://github.com/metosin/reitit/{version}/{filepath}#L{line}" :source-uri "https://github.com/metosin/reitit/{version}/{filepath}#L{line}"
:metadata {:doc/format :markdown}} :metadata {:doc/format :markdown}}
:managed-dependencies [[metosin/reitit "0.1.1-SNAPSHOT"] :managed-dependencies [[metosin/reitit "0.1.1"]
[metosin/reitit-core "0.1.1-SNAPSHOT"] [metosin/reitit-core "0.1.1"]
[metosin/reitit-ring "0.1.1-SNAPSHOT"] [metosin/reitit-ring "0.1.1"]
[metosin/reitit-spec "0.1.1-SNAPSHOT"] [metosin/reitit-spec "0.1.1"]
[metosin/reitit-schema "0.1.1-SNAPSHOT"] [metosin/reitit-schema "0.1.1"]
[metosin/reitit-swagger "0.1.1-SNAPSHOT"] [metosin/reitit-swagger "0.1.1"]
[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] [metosin/reitit-swagger-ui "0.1.1"]
[meta-merge "1.0.0"] [meta-merge "1.0.0"]
[ring/ring-core "1.6.3"] [ring/ring-core "1.6.3"]