Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dariomatias-dev/go-validators
Package of validators for GoLang applications
https://github.com/dariomatias-dev/go-validators
go golang golang-package validators
Last synced: 26 days ago
JSON representation
Package of validators for GoLang applications
- Host: GitHub
- URL: https://github.com/dariomatias-dev/go-validators
- Owner: dariomatias-dev
- License: mit
- Created: 2024-02-18T20:11:56.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T15:33:38.000Z (2 months ago)
- Last Synced: 2024-10-19T22:13:51.142Z (2 months ago)
- Topics: go, golang, golang-package, validators
- Language: Go
- Homepage:
- Size: 293 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Validation Package
The package provides a set of validation utilities to check various conditions in data fields. These validators can be used to ensure data integrity and enforce specific requirements in your Go applications, making use only of native libraries to perform the validations.
## Objective
The aim is to offer a simple and flexible way to perform data validation in Go applications in a customizable manner. By providing a set of validators, developers can easily incorporate data validation logic into their applications to ensure data consistency and meet specific validation requirements, without the need to write validation code from scratch, customizing validations according to the project's needs.
## Installation
To use the package in your Go projects, type the following command in your terminal:
```bash
go get github.com/dariomatias-dev/go-validators
```
## Order of Validators
Validators should be organized following the following order: presence validator, type validator, and value validators. They should follow this order because otherwise, an error may occur if the sent value is not accepted by a validator that is placed later, even if it is a valid value.
This organization ensures that basic requirements, such as presence and type, are validated first before more specific validations about the value itself. By validating in this order, we can detect any potential errors early in the process, leading to a more robust and error-free validation system.
Just as there are no reasons to check if the value is of a specific type in value validators, which require the sent value to be of a certain type, as there are dedicated validators for this purpose, thus reducing the number of checks, making the validation process more efficient.
## How to Use
To use the package, first import it into your project with the following import statement:
```go
import "github.com/dariomatias-dev/go-validators"
```
I advise you to give it an alias to make package usage simpler and more efficient, like this:
```go
import v "github.com/dariomatias-dev/go-validators"
```
### Functionality of Validators
The validators have been created based on configurable functions, where the first set of parameters within the first pair of parentheses is used to configure the behavior of the validator, while the second set of parentheses receives the value to be validated.
In the table of [validators-available](#validators-available), it's referenced which validators require which value to be provided in order to perform validation.
### Usage
To use the validations, use `v.` followed by the desired validation. In the first parenthesis, provide what is being requested, and if you don't want the default error message, insert the desired message afterwards.
The validators will return two values: the first will be the error message if the provided value did not pass validation, and the second will be a boolean value indicating whether the validations should be halted or not. The second value is used in situations where, if the value did not pass the validator, subsequent validations cannot be executed because they will result in an error.
Validations can be performed in three distinct ways: [individually](#validate-individual-value), or within a [json](#validate-json).
#### Validate Individual Value
A single validator is applied to a specific value.
**Examples:**
```go
// Success
value := 4
err, _ := v.Min(3)(value) // nil, false
if err != nil {
fmt.Println(err)
return
}
// Error
value = 2
err, _ = v.Min(3)(value) // The minimum value is 3, but it received 2, false
if err != nil {
fmt.Println(err)
return
}
```
#### Validate JSON
Validates the provided JSON based on the validators defined for each field, returning an error if there is an inconsistency, or assigning the values from the JSON to the provided struct if there are no errors.
**Examples:**
```go
type UserModel struct {
Name string `json:"name" validates:"required;isString;minLength=3;maxLength=20"`
Age int `json:"age" validates:"required;isInt;min=18;max=100"`
Email string `json:"email" validates:"required;email"`
}
user := UserModel{}
json := `{
"name": "Name",
"age": 18,
"email": "[email protected]"
}`
// Success
err := Validate(&user, json) // Output: nil
if err != nil {
fmt.Println(err)
return
}
// Error
json := `{
"name": "Name",
"age": 16,
"email": "[email protected]"
}`
err := Validate(&user, json) // Output: {"age":["The minimum value is 18, but it received 16."]}
if err != nil {
fmt.Println(err)
return
}
```
### Validators Available
Validator
Type
Input
Value Type
Required
Presence
-
Error message
any
IsString
Type
-
Error message
string
IsNumber
Type
-
Error message
int | float
IsInt
Type
-
Error message
int
IsFloat
Type
-
Error message
float
IsBool
Type
-
Error message
bool
IsArray
Type
- Field validators*
- Error message
slice | array
IsNullString
Type
-
Error message
nil | string
IsNullNumber
Type
-
Error message
nil | int | float
IsNullInt
Type
-
Error message
nil | int
IsNullFloat
Type
-
Error message
nil | float
IsNullBool
Type
-
Error message
nil | bool
IsNullArray
Type
- Field validators*
- Error message
nil | slice | array
Value
- Minimum value*
- Error messages
- Invalid email
- Value is not string
string
Password
Value
-
Error message
string
Min
Value
- Minimum value*
- Error message
int | int32 | int64 | float32 | float64
Max
Value
- Maximum value*
- Error message
int | int32 | int64 | float32 | float64
Length
Value
- Size*
- Error message
string | slice | array
MinLength
Value
- Minimum size*
- Error message
string | slice | array
MaxLength
Value
- Maximum size*
- Error message
string | slice | array
IsAlpha
Value
-
Error message
string
IsAlphaNum
Value
-
Error message
string
IsAlphaSpace
Value
-
Error message
string
IsAlphaNumSpace
Value
-
Error message
string
StartsWith
Value
- Starts with*
- Error message
string
StartsNotWith
Value
- Starts not with*
- Error message
string
EndsWith
Value
- Ends with*
- Error message
string
EndsNotWith
Value
- Ends not with*
- Error message
string
Regex
Value
- Regex*
- Error message
string
Url
Value
-
Error message
string
Uuid
Value
-
Version (Default Version 5)
-
Error message
string
OneOf
Value
-
Options*
-
Error message
string
Custom
Value
-
Custom validator*
any
### **All entries marked with (\*) are mandatory.**
# Donations
Help maintain the project with donations.
[](https://www.buymeacoffee.com/dariomatias)