handlerfunc

README

handlerfunc

Commonly used public handlers.

Example of use

	r := gin.New()
	r.GET("/health", handlerfunc.CheckHealth)
	r.GET("/ping", handlerfunc.Ping)

Documentation

Overview

Package handlerfunc is used for public http request handler.

Index

• func BrowserRefresh(path string) func(c *gin.Context)
• func BrowserRefreshFS(fs embed.FS, path string) func(c *gin.Context)
• func CheckHealth(c *gin.Context)
• func ListCodes(c *gin.Context)
• func Ping(c *gin.Context)
• type CheckHealthReply

Functions

func BrowserRefresh

func BrowserRefresh(path string) func(c *gin.Context)

BrowserRefresh solve vue using history route 404 problem, for system file

func BrowserRefreshFS

func BrowserRefreshFS(fs embed.FS, path string) func(c *gin.Context)

BrowserRefreshFS solve vue using history route 404 problem, for embed.FS

func CheckHealth

func CheckHealth(c *gin.Context)

CheckHealth check healthy. @Summary check health @Description check health @Tags system @Accept json @Produce json @Success 200 {object} CheckHealthReply{} @Router /health [get]

func ListCodes

func ListCodes(c *gin.Context)

ListCodes list error codes info @Summary list error codes info @Description list error codes info @Tags system @Accept json @Produce json @Router /codes [get]

func Ping

func Ping(c *gin.Context)

Ping ping @Summary ping @Description ping @Tags system @Accept json @Produce json @Router /ping [get]

Types

type CheckHealthReply

type CheckHealthReply struct {
	Status   string `json:"status"`
	Hostname string `json:"hostname"`
}

CheckHealthReply check health result