6d913fc343
* fix(binding): Expose validator engine used by the default Validator
- Add func ValidatorEngine for returning the underlying validator engine used
in the default StructValidator implementation.
- Remove the function RegisterValidation from the StructValidator interface
which made it immpossible to use a StructValidator implementation without the
validator.v8 library.
- Update and rename test for registering validation
Test{RegisterValidation => ValidatorEngine}.
- Update readme and example for registering custom validation.
- Add example for registering struct level validation.
- Add documentation for the following binding funcs/types:
- Binding interface
- StructValidator interface
- Validator instance
- Binding implementations
- Default func
* fix(binding): Move validator engine getter inside interface
* docs: rm date cmd from custom validation demo
65 lines
1.9 KiB
Go
65 lines
1.9 KiB
Go
package main
|
|
|
|
import (
|
|
"net/http"
|
|
"reflect"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/gin-gonic/gin/binding"
|
|
validator "gopkg.in/go-playground/validator.v8"
|
|
)
|
|
|
|
// User contains user information.
|
|
type User struct {
|
|
FirstName string `json:"fname"`
|
|
LastName string `json:"lname"`
|
|
Email string `binding:"required,email"`
|
|
}
|
|
|
|
// UserStructLevelValidation contains custom struct level validations that don't always
|
|
// make sense at the field validation level. For example, this function validates that either
|
|
// FirstName or LastName exist; could have done that with a custom field validation but then
|
|
// would have had to add it to both fields duplicating the logic + overhead, this way it's
|
|
// only validated once.
|
|
//
|
|
// NOTE: you may ask why wouldn't not just do this outside of validator. Doing this way
|
|
// hooks right into validator and you can combine with validation tags and still have a
|
|
// common error output format.
|
|
func UserStructLevelValidation(v *validator.Validate, structLevel *validator.StructLevel) {
|
|
user := structLevel.CurrentStruct.Interface().(User)
|
|
|
|
if len(user.FirstName) == 0 && len(user.LastName) == 0 {
|
|
structLevel.ReportError(
|
|
reflect.ValueOf(user.FirstName), "FirstName", "fname", "fnameorlname",
|
|
)
|
|
structLevel.ReportError(
|
|
reflect.ValueOf(user.LastName), "LastName", "lname", "fnameorlname",
|
|
)
|
|
}
|
|
|
|
// plus can to more, even with different tag than "fnameorlname"
|
|
}
|
|
|
|
func main() {
|
|
route := gin.Default()
|
|
|
|
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
|
|
v.RegisterStructValidation(UserStructLevelValidation, User{})
|
|
}
|
|
|
|
route.POST("/user", validateUser)
|
|
route.Run(":8085")
|
|
}
|
|
|
|
func validateUser(c *gin.Context) {
|
|
var u User
|
|
if err := c.ShouldBindJSON(&u); err == nil {
|
|
c.JSON(http.StatusOK, gin.H{"message": "User validation successful."})
|
|
} else {
|
|
c.JSON(http.StatusBadRequest, gin.H{
|
|
"message": "User validation failed!",
|
|
"error": err.Error(),
|
|
})
|
|
}
|
|
}
|