https://github.com/ramadani/go-unique-validator
Unique validator extensions for govalidator. Inspired by Laravel's unique validation rule.
https://github.com/ramadani/go-unique-validator
golang-package govalidator unique-entity validator
Last synced: about 1 month ago
JSON representation
Unique validator extensions for govalidator. Inspired by Laravel's unique validation rule.
- Host: GitHub
- URL: https://github.com/ramadani/go-unique-validator
- Owner: ramadani
- License: mit
- Created: 2018-11-13T12:27:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-09T14:04:46.000Z (over 5 years ago)
- Last Synced: 2025-03-30T13:34:57.846Z (2 months ago)
- Topics: golang-package, govalidator, unique-entity, validator
- Language: Go
- Homepage:
- Size: 3.91 KB
- Stars: 8
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-unique-validator
Unique validator extensions for [thedevsaddam/govalidator](https://github.com/thedevsaddam/govalidator). Inspired by Laravel's unique validation rule.
## Installation
Before use this validator, you need to install [thedevsaddam/govalidator](https://github.com/thedevsaddam/govalidator) first, and then install this package.
```cmd
go get github.com/ramadani/go-unique-validator
```
## Usage
Import this package to your code
```go
import uniquevalidator "github.com/ramadani/go-unique-validator"
```
Create db instance
```go
db, err := sql.Open("mysql", "username:password@tcp(127.0.0.1:3306)/dbname?parseTime=true")
if err != nil {
log.Fatal(err)
}
defer db.Close()
```
Add as custom rule to govalidator
```go
uniqueRule := uniquevalidator.NewUniqueRule(db, "unique")
govalidator.AddCustomRule("unique", uniqueRule.Rule)
```
#### Example Rule
Format: `unique:table,column,except,idColumn`
To check if attribute is unique:
```go
rules := govalidator.MapData{
"email": []string{"required", "email", "unique:users,email"},
}
```
Forcing A Unique Rule To Ignore A Given ID:
```go
rules := govalidator.MapData{
"email": []string{"required", "email", "unique:users,email,id,123"},
}
```
### Example Usage
```go
package main
import (
"database/sql"
"encoding/json"
"fmt"
"log"
"net/http"
_ "github.com/go-sql-driver/mysql"
uniquevalidator "github.com/ramadani/go-unique-validator"
"github.com/thedevsaddam/govalidator"
)
func handler(w http.ResponseWriter, r *http.Request) {
rules := govalidator.MapData{
"email": []string{"required", "email", "unique:users,email"},
}
opts := govalidator.Options{
Request: r, // request object
Rules: rules, // rules map
RequiredDefault: true, // all the field to be pass the rules
}
v := govalidator.New(opts)
e := v.Validate()
err := map[string]interface{}{"validationError": e}
w.Header().Set("Content-type", "application/json")
json.NewEncoder(w).Encode(err)
}
func main() {
db, err := sql.Open("mysql", "username:password@tcp(127.0.0.1:3306)/dbname?parseTime=true")
if err != nil {
log.Fatal(err)
}
defer db.Close()
uniqueRule := uniquevalidator.NewUniqueRule(db, "unique")
govalidator.AddCustomRule("unique", uniqueRule.Rule)
http.HandleFunc("/", handler)
fmt.Println("Listening on port: 9000")
http.ListenAndServe(":9000", nil)
}
```
Send request to the server using curl or postman: `curl GET "http://localhost:[email protected]"`
**Response**
```json
{
"validationError": {
"email": [
"The email has already been taken"
]
}
}
```
## **License**
The **go-unique-validator** is an open-source software licensed under the [MIT License](LICENSE.md).