Skip to content

Commit

Permalink
Update README with option information
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed Nov 15, 2024
1 parent eb5c239 commit fdbecad
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,31 @@ configuration:
:example.handler/root {}}
```

The `:routes` option defines the Reitit routes. Other options are
passed directly to the Reitit router.

Once initiated the `:duct.router/reitit` key will produce a Ring
handler.

There are four top level options available:

- `:routes` - the Reitit routing data
- `:middleware` - a vector of middleware to apply to the Ring handler
- `:data` - data to add to every Reitit route
- `:default-handler` - a default handlers for error conditions

The `:data` key takes a map and acts as it does in Reitit, except for
the following keys:

- `:muuntaja` - a map of Muuntaja options to be merged with the defaults
- `:coercion` - one of: `:malli`, `:schema` or `:spec`

These keys will automatically add relevant middleware.

The `:default-handler` key holds a map that takes the same keys as the
Reitit `create-default-handler` function:

- `:not-found` - a handler for 404 HTTP errors
- `:method-not-allowed` - a handler for 405 HTTP errors
- `:not-acceptable` - a handler for 406 HTTP errors

## License

Copyright © 2024 James Reeves
Expand Down

0 comments on commit fdbecad

Please sign in to comment.