https://github.com/xuender/kvalid
Lightweight validation library that can export rules as JSON so browsers can apply the same rules.
https://github.com/xuender/kvalid
bind golang-library rules validation
Last synced: 2 months ago
JSON representation
Lightweight validation library that can export rules as JSON so browsers can apply the same rules.
- Host: GitHub
- URL: https://github.com/xuender/kvalid
- Owner: xuender
- License: mit
- Created: 2023-08-31T02:35:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T02:27:53.000Z (11 months ago)
- Last Synced: 2025-02-09T19:40:50.710Z (4 months ago)
- Topics: bind, golang-library, rules, validation
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# kvalid
[![Action][action-svg]][action-url]
[![Report Card][goreport-svg]][goreport-url]
[![Codecov][codecov-svg]][codecov-url]
[![Lines of code][lines-svg]][lines-url]
[![Godoc][godoc-svg]][godoc-url]
[![License][license-svg]][license-url]
✨ **`xuender/kvalid` is a lightweight validation library that can export rules as JSON so browsers can apply the same rules.**
Based on Go 1.18+ Generics.
Learn from [github.com/AgentCosmic/xvalid](https://github.com/AgentCosmic/xvalid) .
## 💡 Usage
Define rules:
```go
import (
"fmt"
"net/http"
"github.com/xuender/kvalid"
"github.com/xuender/kvalid/json"
)
type Book struct {
Title string `json:"title"`
Author string `json:"author,omitempty"`
Amount float64
Num int
}
// nolint: gomnd
func (p *Book) Validation(method string) *kvalid.Rules[*Book] {
switch method {
case http.MethodPut:
return kvalid.New(p).
Field(&p.Amount,
kvalid.Required().SetMessage("amount required"),
kvalid.MinNum(10.3).Optional().SetMessage("amount min 10.3"),
kvalid.MaxNum(2000.0).SetMessage("amount max 2000"),
).
Field(&p.Num, kvalid.Ignore())
case http.MethodPost:
return kvalid.New(p).
Field(&p.Title,
kvalid.Required().SetMessage("title required"),
kvalid.MaxStr(200).SetMessage("title max 200"),
).
Field(&p.Author,
kvalid.Required().SetMessage("author required"),
kvalid.MaxStr(100).SetMessage("author max 100"),
)
default:
panic("illegal method:" + method)
}
}
func (p *Book) Validate(method string) error {
return p.Validation(method).Validate(p)
}
```
Validate object:
```go
book := &Book{}
fmt.Println(book.Validate(http.MethodPost))
```
Export rules as JSON:
```go
data, _ := json.Marshal(book.Validation(http.MethodPut))
fmt.Println(string(data))
```
Bind object:
```go
source := &Book{Amount: 99.9, Num: 3}
target := &Book{}
rules := source.Validation(http.MethodPut)
rules.Bind(source, target)
```
## 🔍️ Validators
* MaxNum, MinNum
* int, int8, int16, int32, int64
* uint, uint8, uint16, uint32, uint64
* float32, float64
* byte, rune
* MaxStr, MinStr
* MaxNullInt, MinNullInt
* Required
* Pattern
* Email, URL
* FieldFunc, StructFunc, Ignore
## 📊 Graphs
![Graphs][graphs-svg]
## 👤 Contributors
![Contributors][contributors-svg]
## 📝 License
© ender, 2023~time.Now
[MIT LICENSE][license-url]
[action-url]: https://github.com/xuender/kvalid/actions
[action-svg]: https://github.com/xuender/kvalid/workflows/Go/badge.svg
[goreport-url]: https://goreportcard.com/report/github.com/xuender/kvalid
[goreport-svg]: https://goreportcard.com/badge/github.com/xuender/kvalid
[godoc-url]: https://godoc.org/github.com/xuender/kvalid
[godoc-svg]: https://godoc.org/github.com/xuender/kvalid?status.svg
[license-url]: https://github.com/xuender/kvalid/blob/master/LICENSE
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[contributors-svg]: https://contrib.rocks/image?repo=xuender/kvalid
[codecov-url]: https://codecov.io/gh/xuender/kvalid
[codecov-svg]: https://codecov.io/gh/xuender/kvalid/graph/badge.svg?token=HYNXZQ5OZ7
[graphs-svg]: https://codecov.io/gh/xuender/kvalid/graphs/tree.svg?token=HYNXZQ5OZ7
[lines-svg]: https://sloc.xyz/github/xuender/kvalid
[lines-url]: https://github.com/boyter/scc