module Athena::Routing::ErrorRendererInterface

Overview

An ART::ErrorRendererInterface converts an ::Exception into an ART::Response.

By default, exceptions are JSON serialized via ART::ErrorRenderer. However, it can be overridden to allow rendering errors differently, such as via HTML.

require "athena"

# Alias this service to be used when the `ART::ErrorRendererInterface` type is encountered.
@[ADI::Register(alias: ART::ErrorRendererInterface)]
struct Athena::Routing::CustomErrorRenderer
  include Athena::Routing::ErrorRendererInterface

  # :inherit:
  def render(exception : ::Exception) : ART::Response
    if exception.is_a? ART::Exceptions::HTTPException
      status = exception.status
      headers = exception.headers
    else
      status = HTTP::Status::INTERNAL_SERVER_ERROR
      headers = HTTP::Headers.new
    end

    body = <<-HTML
      <html>
        <head>
          <title>Uh oh</title>
        </head>
        <body>
          <h1>Uh oh, something went wrong</h1>
        </body>
      </html>
    HTML

    headers["content-type"] = "text/html"

    ART::Response.new body, status, headers
  end
end

class TestController < ART::Controller
  get "/" do
    raise "some error"
  end
end

ART.run

# GET / # =>   <html><head><title>Uh oh</title></head><body><h1>Uh oh, something went wrong</h1></body></html>

Direct including types

Athena::Routing::ErrorRenderer

Defined in:

error_renderer_interface.cr

Instance Method Summary

#render(exception : Exception) : ART::Response
Renders the given exception into an ART::Response.

Instance Method Detail

abstract def render(exception : Exception) : ART::Response #

Renders the given exception into an ART::Response.

[View source]