module Orion::DSL::Handlers

Overview

Handlers allow you to maniplate the request stack by passing instances of classes implementing the HTTP::Handler (a.k.a. middleware) module.

Handlers will only apply to the routes specified below them, so be sure to place your handlers near the top of your route.

use HTTP::ErrorHandler
use HTTP::LogHandler.new(File.open("tmp/application.log"))

Nested Routes using scope

Scopes are a method in which you can nest routes under a common path. This prevents the need for duplicating paths and allows a developer to easily change the parent of a set of child paths.

scope "users" do
  root to: "Users#index"
  get ":id", to: "Users#show"
  delete ":id", to: "Users#destroy"
end

Handlers within nested routes

Instances of link:https://crystal-lang.org/api/HTTP/Handler.html[HTTP::Handler] can be used within a scope block and will only apply to the subsequent routes within that scope. It is important to note that the parent context's handlers will also be used.

Handlers will only apply to the routes specified below them, so be sure to place your handlers near the top of your scope.

scope "users" do
  use AuthorizationHandler.new
  root to: "Users#index"
  get ":id", to: "Users#show"
  delete ":id", to: "Users#destroy"
end

Defined in:

orion/dsl/handlers.cr

Macro Summary

• handlers

  Direct access the handlers array, giving you access to methods like unshift, push and clear.

• use(handler)

  Insert a new handler.

Macro Detail