accelbyte / justice-input-validation-go

justice-input-validation-go

This is AccelByte Justice Golang Input Validation package. This package is extending functionality from govalidator and add some additional rule to it.

Usage

Importing package

import validator "github.com/AccelByte/justice-input-validation-go"

Validating struct from request data model

We can validate a struct that have validation tag literal with validateStruct() method

import validator "github.com/AccelByte/justice-input-validation-go"

// example of a request model
type requestModel struct {
  Name  string `valid:"displayName"`
  Email string `valid:"email"`
}

reqData = requestModel{
    Name: "Jhon Doe",
    Email: "[email protected]",
}

// validating struct
if valid, err := validator.ValidateStruct(reqData); !valid || err {
    // do something when reqData is invalid
}
 

List of available validators with its corresponding function that defined in rules.go file

"tag"                   : IsTag
"language"              : IsLanguage
"topic"                 : IsTopic
"displayName"           : IsDisplayName
"personName"            : IsPersonName
"uuid4WithoutHyphens"   : IsUUID4WithoutHyphens
"permissionResource"    : IsPermissionResource
"path"                  : IsPath
"url"                   : IsURL
"uri"                   : IsURI
"dateTime"              : IsDateTime
"date"                  : IsDate
"jwt"                   : IsJWT
"password"              : IsPassword
"email"                 : IsEmail
"codeChallenge"         : IsCodeChallenge
"notContainWhitespace"  : IsNotContainWhitespace
"containWhitespace"     : IsContainWhitespace
"country"               : IsCountry
"namespace"             : IsNamespace

And of course this package is not limiting the functionality that came from govalidator package, you can use all available validation rules that supported by govalidator package.

justice-input-validation-go's Issues

No CICD, makefile and license

It would be better if we enable CICD using Travis for this repo. At least we run the linter and test in that pipeline. We can take a look at this file for reference: https://github.com/AccelByte/iam-go-sdk/blob/master/.travis.yml

In order to run make test we also need to create a Makefile.

The other thing is, we need to add a license file.