servers

Documentation

Index

• func Healthcheck(c *gin.Context)
• func New(ctx context.Context, conf *Config) (*http.Server, error)
• type Config
• type GenericResponse
• type Handler
• type HealthcheckResponse
• type PageInfo

Functions

func Healthcheck

func Healthcheck(c *gin.Context)

func New

func New(ctx context.Context, conf *Config) (*http.Server, error)

Types

type Config

type Config struct {
	Host string
	Port int
}

type GenericResponse

type GenericResponse struct {
	Status *string  `json:"status,omitempty" yaml:"status,omitempty" example:"OK"`
	Errors []string `json:"errors,omitempty" yaml:"errors,omitempty" example:"[\"error1\", \"error2\"]"`
}

type Handler

type Handler interface {
	Healthcheck(c *gin.Context)
}

type HealthcheckResponse

type HealthcheckResponse struct {
	Status string `json:"status" example:"OK"`
}

type PageInfo

type PageInfo struct {
	HasNextPage bool `json:"has_next_page"`
	HasPrevPage bool `json:"has_prev_page"`
	TotalRecord int  `json:"total_record"`
	TotalPage   *int `json:"total_page,omitempty"`
}