struct Athena::Routing::Route(Controller, ActionType, ReturnType, ArgTypeTuple, ArgumentsType)

• Athena::Routing::Route(Controller, ActionType, ReturnType, ArgTypeTuple, ArgumentsType)
• Athena::Routing::Action
• Struct
• Value
• Object

Overview

Represents an endpoint within the application.

Includes metadata about the endpoint, such as its controller, arguments, return type, and the action should be executed.

Defined in:

Constructors

• .new(action : ActionType, action_name : String, method : String, arguments : ArgumentsType, param_converters : Array(ART::ParamConverterInterface::ConfigurationInterface), _controller : Controller.class, _return_type : ReturnType.class, _arg_types : ArgTypeTuple.class)

Instance Method Summary

• #action_name : String

  The name of the the controller action related to self.

• #arguments : ArgumentsType

  An Array(ART::Arguments::ArgumentMetadata) that self requires.

• #controller : Controller.class

  The ART::Controller that includes self.

• #execute(arguments : Array) : ReturnType

  Executes the action related to self with the provided arguments array.

• #method : String

  The HTTP method associated with self.

• #param_converters : Array(ART::ParamConverterInterface::ConfigurationInterface)

  An Array(ART::ParamConverterInterface::ConfigurationInterface) representing the ART::ParamConverters applied to self.

• #return_type : ReturnType.class

  The type that self's route should return.

Constructor Detail

Instance Method Detail