router

package

v1.12.2 Latest Latest Go to latest Published: Jan 29, 2026 License: GPL-3.0 Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

func HealthCheck(ctx *gin.Context)

HealthCheck handles the health check functionality by logging a message and returning "pong" as the response.

type Router struct {
	Engine *gin.Engine
	Cfg    config.File
}

Router is a small builder around gin.Engine to assemble middlewares and routes without leaking application-specific logic into this package.

func NewRouter(cfg config.File) *Router

NewRouter creates a new Router builder with a fresh gin.Engine.

func (r *Router) Build() *gin.Engine

Build returns the underlying gin.Engine.

func (r *Router) WithBackchannel(setup func(*gin.Engine)) *Router

WithBackchannel registers the backchannel API endpoints via the provided setup function.

func (r *Router) WithFrontend(setupHydra, setup2FA, setupWebAuthn, setupNotify func(*gin.Engine)) *Router

WithFrontend calls the provided setup functions to register the frontend pages.

func (r *Router) WithHealth(handler gin.HandlerFunc) *Router

WithHealth registers the health endpoint using the given handler.

func (r *Router) WithMetricsMiddleware() *Router

WithMetricsMiddleware enables Prometheus request metrics middleware.

func (r *Router) WithMetricsRoute(handler gin.HandlerFunc) *Router

WithMetricsRoute registers the GET /metrics handler provided by the caller.

func (r *Router) WithRecovery() *Router

WithRecovery adds gin.Recovery middleware to recover from panics.

func (r *Router) WithRequestDecompression() *Router

WithRequestDecompression installs request decompression middlewares (gzip, zstd, br).

func (r *Router) WithResponseCompression() *Router

WithResponseCompression applies response compression according to server config.

func (r *Router) WithStatic(setup func(*gin.Engine)) *Router

WithStatic runs the provided setup function to add static routes.

func (r *Router) WithTrustedProxies() *Router

WithTrustedProxies configures the trusted proxies for the underlying engine.