component

func Component ¶

func Component(mount func(*gin.Engine), filters ...slogGin.Filter) bootstrap.IComponent

Component initialises the Gin router and mounts all routes.

CORS origins are read from env automatically during Init():

• prod environment: cors.allow.origins.prod
• other environments: cors.allow.origins.dev

mount is called once during Init() to register all routes. The *gin.Engine created here should be shared with the HTTP server component via a closure variable captured in the caller's main function:

var router *gin.Engine
Add(ginComp.Component(func(r *gin.Engine) {
    router = r
    adapter.Mount(r)
})).
Add(httpComp.Component(func() http.Handler { return router }))

filters is optional (trailing variadic, existing callers passing only mount are unaffected) and is passed straight through to libGin.InitGin - see that function's doc comment. E.g. Component(mount, slogGin.IgnorePath("/")) silences request logging for a noisy health-check endpoint.

var router *gin.Engine
Add(ginComp.Component(func(r *gin.Engine) {
    router = r
    adapter.Mount(r)
})).
Add(httpComp.Component(func() http.Handler { return router }))

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
	ginComp "github.com/phcp-tech/common-library-golang/gin/component"
)

func main() {
	var router *gin.Engine
	c := ginComp.Component(func(r *gin.Engine) {
		router = r
	})
	fmt.Println(c != nil)
	fmt.Println(c.Name())
	_ = router
	_ = http.NewServeMux() // suppress unused import
}

Output:
true
gin