Skip to content

struct Athena::Framework::Config::ContentNegotiation
inherits Struct #

Configuration options for ATH::Listeners::Format. See .configure.

Constructors#

.new(rules : Array(ATH::Config::ContentNegotiation::Rule))#

View source

.new(*rules : ATH::Config::ContentNegotiation::Rule)#

View source

Class methods#

.configure : self | ::Nil#

This method should be overridden in order to provide the configuration for ATH::Listeners::Format. See the external documentation for more details.

By default it returns nil, which disables the listener.

def ATH::Config::ContentNegotiation.configure : ATH::Config::ContentNegotiation?
  new(
    # Setting fallback_format to json means that instead of considering
    # the next rule in case of a priority mismatch, json will be used.
    Rule.new(priorities: ["json", "xml"], host: "api.example.com", fallback_format: "json"),
    # Setting fallback_format to false means that instead of considering
    # the next rule in case of a priority mismatch, a 406 will be returned.
    Rule.new(path: /^\/image/, priorities: ["jpeg", "gif"], fallback_format: false),
    # Setting fallback_format to nil (or not including it) means that
    # in case of a priority mismatch the next rule will be considered.
    Rule.new(path: /^\/admin/, priorities: ["xml", "html"]),
    # Setting a priority to */* basically means any format will be matched.
    Rule.new(priorities: ["text/html", "*/*"], fallback_format: "html"),
  )
end
View source

Methods#

#rules : Array(ATH::Config::ContentNegotiation::Rule)#

Returns the content negotiation rules that should be considered when determining the request's format.

View source