https://github.com/guiferpa/gody
:balloon: A lightweight struct validator for Go
https://github.com/guiferpa/gody
go golang struct struct-tags validator validator-struct
Last synced: 22 days ago
JSON representation
:balloon: A lightweight struct validator for Go
- Host: GitHub
- URL: https://github.com/guiferpa/gody
- Owner: guiferpa
- License: mit
- Created: 2018-11-01T21:08:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-28T19:56:16.000Z (10 months ago)
- Last Synced: 2024-09-22T09:21:43.155Z (8 months ago)
- Topics: go, golang, struct, struct-tags, validator, validator-struct
- Language: Go
- Homepage: https://pkg.go.dev/github.com/guiferpa/gody
- Size: 69.3 KB
- Stars: 68
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go-extra - gody - 11-01T21:08:16Z|2021-02-02T15:18:35Z| (Validation / Fail injection)
README
# gody
[](https://github.com/avelino/awesome-go)
[](https://godoc.org/github.com/guiferpa/gody)
[](https://goreportcard.com/report/github.com/guiferpa/gody)
[](https://cloud.drone.io/guiferpa/gody)
[](https://coveralls.io/github/guiferpa/gody?branch=master)
[](https://github.com/guiferpa/gody/releases/latest)
### [Go versions supported](https://github.com/guiferpa/gody/commit/312f2e79be13aeb17e351d61283dfa0ea7aef15a#diff-b31f1e5654d027d84c24cdba2ff31ab79e3ea617091ed348a97476a27b076078R12)
### Installation
```bash
go get github.com/guiferpa/gody/v2
```
### Usage
```go
package main
import (
"encoding/json"
"fmt"
"net/http"
gody "github.com/guiferpa/gody/v2"
"github.com/guiferpa/gody/v2/rule"
)
type RequestBody struct {
Name string `json:"name" validate:"not_empty"`
Age int `json:"age" validate:"min=21"`
}
func HTTPHandler(v *gody.Validator) http.HandlerFunc {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var body RequestBody
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
// ...
}
defer r.Body.Close()
if isValidated, err := v.Validate(body); err != nil {
// ...
}
})
}
func main() {
validator := gody.NewValidator()
validator.AddRules(rule.NotEmpty, rule.Min)
port := ":3000"
http.ListenAndServe(port, HTTPHandler(validator))
}
```
### Others ways for validation
There are others ways to valid a struct, take a look on functions below:
- **RawValidate** - It's a function that make validate with no rule, it's necessary put the struct for validation, some rule(s) and tag name.
```go
gody.RawValidate(interface{}, string, []gody.Rule) (bool, error)
```
- **Validate** - It's a function that make validate with no rule, it's necessary put the struct for validation and some rule(s).
```go
gody.Validate(interface{}, []gody.Rule) (bool, error)
```
- **RawDefaultValidate** - It's a function that already have [built-in rules](https://github.com/guiferpa/gody/blob/72ce1caecc5fdacf40ee282716ec1b5abe6f7adf/validate.go#L15-L23) configured, it's necessary put the struct for validation, tag name and optional custom rule(s).
```go
gody.RawDefaultValidate(interface{}, string, []gody.Rule) (bool, error)
```
- **DefaultValidate** - It's a function that already have [built-in rules](https://github.com/guiferpa/gody/blob/72ce1caecc5fdacf40ee282716ec1b5abe6f7adf/validate.go#L15-L23) configured, it's necessary put the struct for validation and optional custom rule(s).
```go
gody.DefaultValidate(interface{}, []gody.Rule) (bool, error)
```
### Contribution policies
1. At this time the only policy is don't create a Pull Request directly, it's necessary some discussions for some implementation then open an issue before to dicussion anything about the project.