Skip to content

annotation Athena::Framework::Annotations::Head #

Defines a HEAD endpoint.

Fields#

  • path : String - The path for the endpoint, may also be provided as the first positional argument.
  • name : String - The name of the route. Defaults to controller name + method name down snake-cased.
  • constraints : Hash(String, Regex) - A mapping between a route's path parameters and its constraints.

Example#

@[ATHA::Head(path: "/users")]
def head_user : Nil
end