go-playground-converter is formatter error response inspiration like express-validator in nodejs build on top go-playground-validator.

Go Playground Converter

go-playground-converter is formatter error response inspiration like express-validator in nodejs build on top in go-playground-validator, see more about struct reference follow this.

• Go Playground Converter
  • Installation
  • Function Reference
  • Struct Reference
  • Example Usage
  • Custom Usage
  • Bugs
  • Contributing
  • License

Installation

$ go get -u github.com/restuwahyu13/go-playground-converter

Function Reference

Struct Reference

Example Usage

• Example Usage With Frmework

  package main
  
  import (
    "net/http"
  
    "github.com/gin-gonic/gin"
  
    "github.com/go-playground/validator/v10"
    gpc "github.com/restuwahyu13/go-playground-converter"
  )
  
  type User struct {
    Fullname string `validate:"required,lowercase"`
    Email string `validate:"required,email"`
    Password string `validate:"required,gte=8"`
  }
  
  func main() {
    router := gin.Default()
    router.POST("/", func(ctx *gin.Context) {
  
      var input User
      ctx.ShouldBindJSON(&input)
  
      var validate *validator.Validate
      validators := gpc.NewValidator(validate)
      bind := gpc.NewBindValidator(validators)
  
      config := gpc.ErrorConfig{
        Options: []gpc.ErrorMetaConfig{
            gpc.ErrorMetaConfig{
              Tag: "required",
              Field: "Fullname",
              Message: "fullname is required",
            },
            gpc.ErrorMetaConfig{
              Tag: "lowercase",
              Field: "Fullname",
              Message: "fullname must be a lowercase",
            },
            gpc.ErrorMetaConfig{
              Tag: "required",
              Field: "Email",
              Message: "email is required",
            },
            gpc.ErrorMetaConfig{
              Tag: "email",
              Field: "Email",
              Message: "email format is not valid",
            },
            gpc.ErrorMetaConfig{
              Tag: "required",
              Field: "Password",
              Message: "password is required",
            },
            gpc.ErrorMetaConfig{
              Tag: "gte",
              Field: "Password",
              Message: "password must be greater 7",
            },
          },
        }
  
        errResponse, errCount := bind.BindValidator(&input, config.Options)
  
        if errCount > 0 {
          ctx.JSON(http.StatusBadRequest, errResponse)
          ctx.AbortWithStatus(http.StatusBadRequest)
          return
        } else {
          ctx.JSON(http.StatusOk, gin.H{"message": "register new account successfully"})
        }
    })
  
    router.Run(":3000")
  }
    // error response like this
    //   {
    //     "results": {
    //         "errors": [
    //             {
    //                 "Fullname": {
    //                     "message": "fullname must be a lowercase",
    //                     "value": "Restu Wahyu Saputra",
    //                     "param": "Fullname",
    //                     "tag": "lowercase"
    //                 }
    //             },
    //             {
    //                 "Email": {
    //                     "message": "email format is not valid",
    //                     "value": "restuwahyu13@#gmail.com",
    //                     "param": "Email",
    //                     "tag": "email"
    //                 }
    //             },
    //             {
    //                 "Password": {
    //                     "message": "password must be greater 7",
    //                     "value": "qwerty",
    //                     "param": "Password",
    //                     "tag": "gte"
    //                 }
    //             }
    //         ]
    //     }
    // }

• Example Usage With No Framework

  package main
  
  import (
    "fmt"
  
    "github.com/go-playground/validator/v10"
    gpc "github.com/restuwahyu13/go-playground-converter/utils"
  )
  
  type User struct {
    Fullname string `validate:"required,lowercase"`
    Email string `validate:"required,email"`
    Password string `validate:"required,gte=8"`
  }
  
  func main() {
  
    var input User
    var validate *validator.Validate
    validators := gpc.NewValidator(validate)
    bind := gpc.NewBindValidator(validators)
  
    input.Fullname = "Restu Wahyu Saputra"
    input.Email = "restuwahyu13@#zetmail.com"
    input.Password = "qwerty"
  
    config := gpc.ErrorConfig{
      Options: []gpc.ErrorMetaConfig{
          gpc.ErrorMetaConfig{
            Tag: "required",
            Field: "Fullname",
            Message: "fullname is required",
          },
          gpc.ErrorMetaConfig{
            Tag: "lowercase",
            Field: "Fullname",
            Message: "fullname must be a lowercase",
          },
          gpc.ErrorMetaConfig{
            Tag: "required",
            Field: "Email",
            Message: "email is required",
          },
          gpc.ErrorMetaConfig{
            Tag: "email",
            Field: "Email",
            Message: "email format is not valid",
          },
          gpc.ErrorMetaConfig{
            Tag: "required",
            Field: "Password",
            Message: "password is required",
          },
          gpc.ErrorMetaConfig{
            Tag: "gte",
            Field: "Password",
            Message: "password must be greater 7",
          },
        },
      }
  
    errResponse, errCount := bind.BindValidator(&input, config.Options)
  
    if errCount > 0 {
      fmt.Println(errResponse)
    } else {
      fmt.Println("not error found")
    }
  }
    // error response like this
    //   {
    //     "results": {
    //         "errors": [
    //             {
    //                 "Fullname": {
    //                     "message": "fullname must be a lowercase",
    //                     "value": "Restu Wahyu Saputra",
    //                     "param": "Fullname",
    //                     "tag": "lowercase"
    //                 }
    //             },
    //             {
    //                 "Email": {
    //                     "message": "email format is not valid",
    //                     "value": "restuwahyu13@#gmail.com",
    //                     "param": "Email",
    //                     "tag": "email"
    //                 }
    //             },
    //             {
    //                 "Password": {
    //                     "message": "password must be greater 7",
    //                     "value": "qwerty",
    //                     "param": "Password",
    //                     "tag": "gte"
    //                 }
    //             }
    //         ]
    //     }
    // }

Custom Usage

package util

import (
  "github.com/go-playground/validator/v10"
  gpc "github.com/restuwahyu13/go-playground-converter"
)


func GoValidator(s interface{}, config []gpc.ErrorMetaConfig) (interface{}, int) {
    var validate *validator.Validate
    validators := gpc.NewValidator(validate)
    bind := gpc.NewBindValidator(validators)

    errResponse, errCount := bind.BindValidator(s, config)
    return errResponse, errCount
}

Bugs

For information on bugs related to package libraries, please visit here

Contributing

Want to make Go Playground Converter more perfect ? Let's contribute and follow the contribution guide.

License

• MIT License

BACK TO TOP