Gin でルートを整理する方法

ルート定義でメイン ファイルが乱雑になるのを避けるために、ルートを別のファイルにグループ化できます。このアプローチにより、コードの編成と保守性が向上します。

ネストされたルート グループを作成するには、ルーター変数を構造体変数またはグローバル変数に保存します。その後、個々のファイルでこの共有ルーター インスタンスにハンドラーを追加できます。

実装例

routes.go

package app

import (
    "github.com/gin-gonic/gin"
)

type routes struct {
    router *gin.Engine
}

func NewRoutes() routes {
    return routes{
        router: gin.Default(),
    }
}

func (r routes) addPing(rg *gin.RouterGroup) { }
func (r routes) addUsers(rg *gin.RouterGroup) { }

func (r routes) Run(addr ...string) error { return r.router.Run() }

ping.go

package app

import "github.com/gin-gonic/gin"

func (r routes) addPing(rg *gin.RouterGroup) {
    ping := rg.Group("/ping")
    ping.GET("/", pongFunction)
}

users.go

package app

import "github.com/gin-gonic/gin"

func (r routes) addUsers(rg *gin.RouterGroup) {
    users := rg.Group("/users")
    users.GET("/", getUsersFunction)
}