module Athena::Routing::Requirement

Overview

Includes types related to [route requirements][Athena::Routing::Route--parameter-validation].

The namespace also exposes various regex constants representing common universal requirements to make using them in routes easier.

class ExampleController < ATH::Controller
  @[ARTA::Get(
    "/user/{id}",
    requirements: {
      "id" => ART::Requirement::DIGITS,
    }
  )]
  def get_user(id : Int64) : Int64
    id
  end

  @[ARTA::Get(
    "/article/{slug}",
    requirements: {
      "slug" => ART::Requirement::ASCII_SLUG,
    }
  )]
  def get_article(slug : String) : String
    slug
  end
end

Defined in:

requirement/enum.cr
requirement/requirement.cr

Constant Summary

ASCII_SLUG = /[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*/

CATCH_ALL = /.+/

DATE_YMD = /[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9]|(?<!02-)3[01])/

Matches a date string in the format of YYYY-MM-DD.

DIGITS = /[0-9]+/

POSITIVE_INT = /[1-9][0-9]*/

UID_BASE32 = /[0-9A-HJKMNP-TV-Z]{26}/

UID_BASE58 = /[1-9A-HJ-NP-Za-km-z]{22}/

UID_RFC4122 = /[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}/

ULID = /[0-7][0-9A-HJKMNP-TV-Z]{25}/

UUID = /[0-9a-f]{8}-[0-9a-f]{4}-[12-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V1 = /[0-9a-f]{8}-[0-9a-f]{4}-1[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V3 = /[0-9a-f]{8}-[0-9a-f]{4}-3[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V4 = /[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V5 = /[0-9a-f]{8}-[0-9a-f]{4}-5[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V6 = /[0-9a-f]{8}-[0-9a-f]{4}-6[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V7 = /[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/

UUID_V8 = /[0-9a-f]{8}-[0-9a-f]{4}-8[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/