Group example

This example shows how to make a group of routes per file

This way we can create all routes of a certain topic in its own file so
the code will be cleaner

For example: All "/users" routes could be defined in users.go

group-routes/main.go

@@ -0,0 +1,10 @@
+package main
+
+import (
+ "github.com/gin-gonic/examples/group-routes/routes"
+)
+
+func main() {
+ // Our server will live in the routes package
+ routes.Run()
+}

group-routes/routes/main.go

@@ -0,0 +1,27 @@
+package routes
+
+import (
+ "github.com/gin-gonic/gin"
+)
+
+var (
+ router = gin.Default()
+)
+
+// Run will start the server
+func Run() {
+ getRoutes()
+ router.Run(":5000")
+}
+
+// getRoutes will create our routes of our entire application
+// this way every group of routes can be defined in their own file
+// so this one won't be so messy
+func getRoutes() {
+ v1 := router.Group("/v1")
+ addUserRoutes(v1)
+ addPingRoutes(v1)
+
+ v2 := router.Group("/v2")
+ addPingRoutes(v2)
+}

group-routes/routes/ping.go

@@ -0,0 +1,15 @@
+package routes
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+func addPingRoutes(rg *gin.RouterGroup) {
+ ping := rg.Group("/ping")
+
+ ping.GET("/", func(c *gin.Context) {
+ c.JSON(http.StatusOK, "pong")
+ })
+}

group-routes/routes/users.go

@@ -0,0 +1,21 @@
+package routes
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+func addUserRoutes(rg *gin.RouterGroup) {
+ users := rg.Group("/users")
+
+ users.GET("/", func(c *gin.Context) {
+ c.JSON(http.StatusOK, "users")
+ })
+ users.GET("/comments", func(c *gin.Context) {
+ c.JSON(http.StatusOK, "users comments")
+ })
+ users.GET("/pictures", func(c *gin.Context) {
+ c.JSON(http.StatusOK, "users pictures")
+ })
+}