docs: enhance skipper documentation and simplify examples

- Add examples of skipper usage in both README.md and _example/main.go, including GET and POST methods for `/ping` endpoint with dynamic responses. - Remove the toolchain specification from _example/go.mod. Signed-off-by: Bo-Yi Wu <[email protected]>
gin-contrib · May 9, 2024 · 904b080 · 904b080
1 parent 8db09f4
commit 904b080
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -111,6 +111,20 @@ func main() {
     c.String(http.StatusOK, "pong "+fmt.Sprint(time.Now().Unix()))
   })
 
+  // Example of skipper usage
+  v1 := r.Group("/v1", logger.SetLogger(
+    logger.WithSkipper(func(c *gin.Context) bool {
+      return c.Request.Method == "GET"
+    })))
+  {
+    v1.GET("/ping", func(c *gin.Context) {
+      c.String(http.StatusOK, "pong01 "+fmt.Sprint(time.Now().Unix()))
+    })
+    v1.POST("/ping", func(c *gin.Context) {
+      c.String(http.StatusOK, "pong02 "+fmt.Sprint(time.Now().Unix()))
+    })
+  }
+
   // Listen and Server in 0.0.0.0:8080
   if err := r.Run(":8080"); err != nil {
     log.Fatal().Msg("can' start server with 8080 port")

diff --git a/_example/go.mod b/_example/go.mod
@@ -2,8 +2,6 @@ module test
 
 go 1.21
 
-toolchain go1.21.4
-
 require (
 	github.com/gin-contrib/logger v0.2.6
 	github.com/gin-contrib/requestid v1.0.0

diff --git a/_example/main.go b/_example/main.go
@@ -99,6 +99,20 @@ func main() {
 		c.String(http.StatusOK, "pong "+fmt.Sprint(time.Now().Unix()))
 	})
 
+	// Example of skipper usage
+	v1 := r.Group("/v1", logger.SetLogger(
+		logger.WithSkipper(func(c *gin.Context) bool {
+			return c.Request.Method == "GET"
+		})))
+	{
+		v1.GET("/ping", func(c *gin.Context) {
+			c.String(http.StatusOK, "pong01 "+fmt.Sprint(time.Now().Unix()))
+		})
+		v1.POST("/ping", func(c *gin.Context) {
+			c.String(http.StatusOK, "pong02 "+fmt.Sprint(time.Now().Unix()))
+		})
+	}
+
 	// Listen and Server in 0.0.0.0:8080
 	if err := r.Run(":8080"); err != nil {
 		log.Fatal().Msg("can' start server with 8080 port")