to create new validator, inherit from Apipie::Validator::Base and implement class method build and instance method validate
validator description
# File lib/apipie/validator.rb, line 45 def description "TODO: validator description" end
what type is expected, mostly string this information is used in cli client thor supported types :string, :hash, :array, :numeric, or :boolean
# File lib/apipie/validator.rb, line 60 def expected_type 'string' end
# File lib/apipie/validator.rb, line 40 def param_name @param_description.name end
# File lib/apipie/validator.rb, line 53 def to_json self.description end
# File lib/apipie/validator.rb, line 49 def to_s self.description end
check if value is valid
# File lib/apipie/validator.rb, line 30 def valid?(value) if self.validate(value) @error_value = nil true else @error_value = value false end end
find the right validator for given options
# File lib/apipie/validator.rb, line 21 def self.find(param_description, argument, options, block) @validators.each do |validator_type| validator = validator_type.build(param_description, argument, options, block) return validator if validator end return nil end
# File lib/apipie/validator.rb, line 15 def self.inherited(subclass) @validators ||= [] @validators.insert 0, subclass end
# File lib/apipie/validator.rb, line 11 def initialize(param_description) @param_description = param_description end