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

doc: update all references metosin/reitit => fi.metosin/reitit

Browse source
This commit is contained in:
Joel Kaasinen 2023-08-28 17:42:46 +03:00
parent ccc2b5636e
commit 35264dc130
14 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -52,7 +52,7 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
All main modules bundled:
```clj
[metosin/reitit "0.7.0-alpha5"]
[fi.metosin/reitit "0.7.0-alpha5"]
```
Optionally, the parts can be required separately.

2
doc/README.md
View file

@ -41,7 +41,7 @@ There is [#reitit](https://clojurians.slack.com/messages/reitit/) in [Clojurians
All bundled:
```clj
[metosin/reitit "0.7.0-alpha5"]
[fi.metosin/reitit "0.7.0-alpha5"]
```
Optionally, the parts can be required separately.

2
doc/basics/error_messages.md
View file

@ -22,7 +22,7 @@ The default exception formatting uses `reitit.exception/exception`. It produces
## Pretty Errors
```clj
[metosin/reitit-dev "0.7.0-alpha5"]
[fi.metosin/reitit-dev "0.7.0-alpha5"]
```
For human-readable and developer-friendly exception messages, there is `reitit.dev.pretty/exception` (in the `reitit-dev` module). It is inspired by the lovely errors messages of [ELM](https://elm-lang.org/blog/compiler-errors-for-humans) and [ETA](https://twitter.com/jyothsnasrin/status/1037703436043603968) and uses [fipp](https://github.com/brandonbloom/fipp), [expound](https://github.com/bhb/expound) and [spell-spec](https://github.com/bhauman/spell-spec) for most of heavy lifting.

28
doc/cljdoc.edn
View file

@ -1,18 +1,18 @@
{:cljdoc/include-namespaces-from-dependencies
[metosin/reitit
metosin/reitit-core
metosin/reitit-dev
metosin/reitit-ring
metosin/reitit-http
metosin/reitit-middleware
metosin/reitit-interceptors
metosin/reitit-spec
metosin/reitit-schema
metosin/reitit-swagger
metosin/reitit-swagger-ui
metosin/reitit-frontend
metosin/reitit-sieppari
metosin/reitit-pedestal
[fi.metosin/reitit
fi.metosin/reitit-core
fi.metosin/reitit-dev
fi.metosin/reitit-ring
fi.metosin/reitit-http
fi.metosin/reitit-middleware
fi.metosin/reitit-interceptors
fi.metosin/reitit-spec
fi.metosin/reitit-schema
fi.metosin/reitit-swagger
fi.metosin/reitit-swagger-ui
fi.metosin/reitit-frontend
fi.metosin/reitit-sieppari
fi.metosin/reitit-pedestal
fi.metosin/reitit-openapi]
:cljdoc.doc/tree
[["Introduction" {:file "doc/README.md"}]

4
doc/http/default_interceptors.md
View file

@ -1,13 +1,13 @@
# Default Interceptors
```clj
[metosin/reitit-interceptors "0.7.0-alpha5"]
[fi.metosin/reitit-interceptors "0.7.0-alpha5"]
```
Just like the [ring default middleware](../ring/default_middleware.md), but for interceptors.
### Parameters handling
* `reitit.http.interceptors.parameters/parameters-interceptor`
* `reitit.http.interceptors.parameters/parameters-interceptor`
### Exception handling
* `reitit.http.interceptors.exception/exception-interceptor`

2
doc/http/interceptors.md
View file

@ -5,7 +5,7 @@ Reitit has also support for [interceptors](http://pedestal.io/reference/intercep
## Reitit-http
```clj
[metosin/reitit-http "0.7.0-alpha5"]
[fi.metosin/reitit-http "0.7.0-alpha5"]
```
A module for http-routing using interceptors instead of middleware. Builds on top of the [`reitit-ring`](../ring/ring.md) module having all the same features.

6
doc/http/pedestal.md
View file

@ -3,7 +3,7 @@
[Pedestal](http://pedestal.io/) is a backend web framework for Clojure. `reitit-pedestal` provides an alternative routing engine for Pedestal.
```clj
[metosin/reitit-pedestal "0.7.0-alpha5"]
[fi.metosin/reitit-pedestal "0.7.0-alpha5"]
```
Why should one use reitit instead of the Pedestal [default routing](http://pedestal.io/reference/routing-quick-reference)?
@ -26,8 +26,8 @@ A minimalistic example on how to to swap the default-router with a reitit router
```clj
; [io.pedestal/pedestal.service "0.5.5"]
; [io.pedestal/pedestal.jetty "0.5.5"]
; [metosin/reitit-pedestal "0.7.0-alpha5"]
; [metosin/reitit "0.7.0-alpha5"]
; [fi.metosin/reitit-pedestal "0.7.0-alpha5"]
; [fi.metosin/reitit "0.7.0-alpha5"]
(require '[io.pedestal.http :as server])
(require '[reitit.pedestal :as pedestal])

2
doc/http/sieppari.md
View file

@ -1,7 +1,7 @@
# Sieppari
```clj
[metosin/reitit-sieppari "0.7.0-alpha5"]
[fi.metosin/reitit-sieppari "0.7.0-alpha5"]
```
[Sieppari](https://github.com/metosin/sieppari) is a new and fast interceptor implementation for Clojure, with pluggable async supporting [core.async](https://github.com/clojure/core.async), [Manifold](https://github.com/ztellman/manifold) and [Promesa](http://funcool.github.io/promesa/latest).

2
doc/http/transforming_interceptor_chain.md
View file

@ -65,7 +65,7 @@ There is an extra option in http-router (actually, in the underlying interceptor
### Printing Context Diffs
```clj
[metosin/reitit-interceptors "0.7.0-alpha5"]
[fi.metosin/reitit-interceptors "0.7.0-alpha5"]
```
Using `reitit.http.interceptors.dev/print-context-diffs` transformation, the context diffs between each interceptor are printed out to the console. To use it, add the following router option:

2
doc/ring/default_middleware.md
View file

@ -1,7 +1,7 @@
# Default Middleware
```clj
[metosin/reitit-middleware "0.7.0-alpha5"]
[fi.metosin/reitit-middleware "0.7.0-alpha5"]
```
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.

2
doc/ring/exceptions.md
View file

@ -1,7 +1,7 @@
# Exception Handling with Ring
```clj
[metosin/reitit-middleware "0.7.0-alpha5"]
[fi.metosin/reitit-middleware "0.7.0-alpha5"]
```
Exceptions thrown in router creation can be [handled with custom exception handler](../basics/error_messages.md). By default, exceptions thrown at runtime from a handler or a middleware are not caught by the `reitit.ring/ring-handler`. A good practice is to have a top-level exception handler to log and format errors for clients.

2
doc/ring/ring.md
View file

@ -5,7 +5,7 @@
Read more about the [Ring Concepts](https://github.com/ring-clojure/ring/wiki/Concepts).
```clj
[metosin/reitit-ring "0.7.0-alpha5"]
[fi.metosin/reitit-ring "0.7.0-alpha5"]
```
## `reitit.ring/router`

4
doc/ring/swagger.md
View file

@ -1,7 +1,7 @@
# Swagger Support
```
[metosin/reitit-swagger "0.7.0-alpha5"]
[fi.metosin/reitit-swagger "0.7.0-alpha5"]
```
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.
@ -47,7 +47,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.7.0-alpha5"]
[fi.metosin/reitit-swagger-ui "0.7.0-alpha5"]
```
`reitit.swagger-ui/create-swagger-ui-handler` can be used to create a ring-handler to serve the swagger-ui. It accepts the following options:

2
doc/ring/transforming_middleware_chain.md
View file

@ -59,7 +59,7 @@ There is an extra option in the Ring router (actually, in the underlying middlew
### Printing Request Diffs
```clj
[metosin/reitit-middleware "0.7.0-alpha5"]
[fi.metosin/reitit-middleware "0.7.0-alpha5"]
```
Using `reitit.ring.middleware.dev/print-request-diffs` transformation, the request diffs between each middleware are printed out to the console. To use it, add the following router option: