Skip to content

struct Athena::Framework::Controller::ValueResolvers::QueryParameter
inherits Struct #

Attempts to resolve the value from the request's query parameters for any parameter with the ATHA::MapQueryParameter annotation. Supports most primitive types, as well as arrays of most primitive types, and enums.

The name of the query parameter is assumed to be the same as the controller action parameter's name. This can be customized via the name field on the annotation.

If the controller action parameter is not-nilable nor has a default value and is missing, an ATH::Exception::NotFound exception will be raised by default. Similarly, an exception will be raised if the value fails to be converted to the expected type. The specific type of exception can be customized via the validation_failed_status field on the annotation.

require "athena"

enum Color
  Red
  Green
  Blue
end

class ExampleController < ATH::Controller
  @[ARTA::Get("/")]
  def index(
    @[ATHA::MapQueryParameter] ids : Array(Int32),
    @[ATHA::MapQueryParameter(name: "firstName")] first_name : String,
    @[ATHA::MapQueryParameter] required : Bool,
    @[ATHA::MapQueryParameter] age : Int32,
    @[ATHA::MapQueryParameter] color : Color,
    @[ATHA::MapQueryParameter] category : String = "",
    @[ATHA::MapQueryParameter] theme : String? = nil,
  ) : Nil
    ids        # => [1, 2]
    first_name # => "Jon"
    required   # => false
    age        # => 123
    color      # => Color::Blue
    category   # => ""
    theme      # => nil
  end
end

ATH.run

# GET /?ids=1&ids=2&firstName=Jon&required=false&age=123&color=blue

Included modules

Athena::Framework::Controller::ValueResolvers::Interface

Constructors#

.new#

View source

Methods#

#initialize#

View source

#resolve(request : ATH::Request, parameter : ATH::Controller::ParameterMetadata)#

Returns a value resolved from the provided request and parameter if possible, otherwise returns nil if no parameter could be resolved.

View source