Skip to content

class Athena::Routing::Router
inherits Reference #

Default implementation of ATHA::RouterInterface.

Included modules

Athena::Routing::RouterInterface

Constructors#

.new(request_store : ATH::RequestStore, base_uri : URI?) #

View source

Methods#

#generate(route : String, params : Hash(String, _)? = nil, reference_type : ART::URLGeneratorInterface::ReferenceType = :absolute_path) : String #

Generates a URL to the provided route with the provided params.

By default the path is an ART::URLGeneratorInterface::ReferenceType::Absolute_Path, but can be changed via the reference_type argument.

Any params not related to an argument for the provided route will be added as query params.

require "athena"

class ExampleController < ATH::Controller
  @[ATHA::Get("/add/:value1/:value2", name: "add")]
  def add(value1 : Int32, value2 : Int32, negative : Bool = false) : Int32
    0
  end

  @[ATHA::Get("/")]
  def get_link : String
    ""
  end
end

generator.generate "add", value1: 10, value2: 5 # => /add/10/5
View source

#match(request : ATH::Request) : Amber::Router::RoutedResult(Athena::Framework::ActionBase) #

Matches the provided request with its related ATH::Action.

Todo

Possibly raise a non ATH::Exceptions::HTTPException here to allow caller to determine what to do.

View source

#route_collection #

Returns the ART::RouteCollection associated with this router.

View source