Search code examples
gopackagego-gin

Golang Gin-Gonic Split Routes into Multiple Files


I am looking to split my routes.go into multiple files so that each group is in its own package. Can someone point me to an example of some code where someone has done this with Gin?

i.e.

package auth
...
auth = route.Group("/auth"){
    auth.GET(...
    auth.POST(...
}
...

package users
...
user = route.Group("/user"){
    user.GET(...
    user.POST(...
}
...

package main
import (
     "auth"
     "users"
)
...
router = gin.Default()
router.Register(auth.auth, users.user)
router.Run()
...

Solution

  • The way to do this is to create a function in each that takes a route as a parameter, and then adds the routes to the parameter:

    package auth
    import "...gin"
    func Routes(route *gin.Engine)
    auth := route.Group("/auth"){
        auth.GET(...
        auth.POST(...
    }
    ...
    
    package users
    import "...gin"
    func Routes(route *gin.Engine)
    user := route.Group("/user"){
        user.GET(...
        user.POST(...
    }
    ...
    
    package main
    import (
         "github.com/username/package/sub/auth"
         "github.com/username/package/sub/users"
         "github.com/gin-gonic/gin"
    )
    ...
    router := gin.Default()
    auth.Routes(router) //Added all auth routes
    user.Routes(router) //Added all user routes
    router.Run()
    ...