better doc

.golangci.yml

@@ -4,6 +4,7 @@ run:
 linters:
   enable-all: true
   disable:
+    - tagalign
     - ireturn
     - gofumpt
     - testpackage

lib/examples/add/main.go

@@ -11,11 +11,11 @@ import (
 //
 //	curl 'localhost:3000/double' -d 3
 func main() {
-	r := goapi.New()
+	g := goapi.New()
 
-	goapi.Add(r, Double)
+	goapi.Add(g, Double)
 
-	log.Println(r.Start(":3000"))
+	log.Println(g.Start(":3000"))
 }
 
 // Double for "POST /double" which doubles the input to response.

lib/examples/as-echo-middleware/main.go

@@ -9,13 +9,13 @@ import (
 func main() {
 	e := echo.New()
 
-	router := goapi.New()
+	g := goapi.New()
 
-	router.GET("/hello", func() Res {
+	g.GET("/hello", func() Res {
 		return Res{Data: "World"}
 	})
 
-	e.Use(echo.WrapMiddleware(router.Handler))
+	e.Use(echo.WrapMiddleware(g.Handler))
 
 	_ = e.Start(":3000")
 }

lib/examples/as-gin-middleware/main.go

@@ -11,14 +11,14 @@ import (
 func main() {
 	e := gin.New()
 
-	router := goapi.New()
+	g := goapi.New()
 
-	router.GET("/hello", func() Res {
+	g.GET("/hello", func() Res {
 		return Res{Data: "World"}
 	})
 
 	e.Use(func(ctx *gin.Context) {
-		router.Handler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		g.Handler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			ctx.Next()
 		})).ServeHTTP(ctx.Writer, ctx.Request)
 	})

lib/examples/basic/main.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"fmt"
 	"log"
+	"regexp"
 
 	"github.com/NaturalSelectionLabs/goapi"
 	"github.com/NaturalSelectionLabs/goapi/lib/middlewares/apidoc"
@@ -21,11 +22,13 @@ import (
 //
 //	bash ./lib/examples/basic/test.sh
 func main() {
-	r := goapi.New()
+	g := goapi.New()
 
-	r.POST("/login", func(p ParamsLogin) ResLogin {
+	g.Router().AddFormatChecker("password", passwordChecker{})
+
+	g.POST("/login", func(p ParamsLogin) ResLogin {
 		// If the username and password are not correct, return a LoginFail response.
-		if p.Username != "admin" || p.Password != "123456" {
+		if p.Username != "[email protected]" || p.Password != "123456" {
 			return goapi.StatusUnauthorized{}
 		}
 
@@ -42,17 +45,17 @@ func main() {
 
 	// You can use multiple parameters at the same time to get url values, headers, request context, or request body.
 	// The order of the parameters doesn't matter.
-	r.GET("/users/{id}/posts", GetPosts{})
+	g.GET("/users/{id}/posts", GetPosts{})
 
 	// Install endpoints for openapi doc.
-	apidoc.Install(r, func(doc *openapi.Document) *openapi.Document {
+	apidoc.Install(g, func(doc *openapi.Document) *openapi.Document {
 		// Use this callback to customize the openapi document.
 		doc.Info.Title = "Basic Example"
 		doc.Info.Version = "0.0.1"
 		return doc
 	})
 
-	log.Println(r.Start(":3000"))
+	log.Println(g.Start(":3000"))
 }
 
 // GetPosts is the handler for fetching posts of a user.
@@ -94,3 +97,10 @@ func fetchPosts(c context.Context, id int, keyword, typ string) []string {
 
 	return posts
 }
+
+type passwordChecker struct {
+}
+
+func (passwordChecker) IsFormat(input interface{}) bool {
+	return regexp.MustCompile(`^\d+$`).MatchString(input.(string))
+}

lib/examples/basic/test.sh

@@ -8,7 +8,7 @@ echo
 echo
 echo '== login =='
 
-curl localhost:3000/login -id '{"username": "admin", "password": "123456"}'
+curl localhost:3000/login -id '{"username": "[email protected]", "password": "123456"}'
 
 echo
 echo

lib/examples/basic/types.go

@@ -43,8 +43,9 @@ type ParamsPagination struct {
 // It should be treated as a common json struct of golang, goapi won't do any special handling for it,
 // such as default field tag won't work.
 type ParamsLogin struct {
-	Username string `json:"username"`
-	Password string `json:"password"`
+	Username string `json:"username" format:"email"`
+	// Here format:"password" is a custom format checker added by [goapi.Router.AddFormatChecker].
+	Password string `json:"password" format:"password"`
 }
 
 // PostType of a post.

lib/examples/hello-world/main.go

@@ -15,11 +15,11 @@ type Hello struct {
 }
 
 func main() {
-	r := goapi.New()
+	g := goapi.New()
 
-	r.GET("/", func() Hello {
+	g.GET("/", func() Hello {
 		return Hello{Data: "Hello World!"}
 	})
 
-	log.Println(r.Start(":3000"))
+	log.Println(g.Start(":3000"))
 }