http

type Claim struct {
	ID            string // user id
	UserValue     string // user value
	Secret        string // secret for jwt
	Name          string // username
	Token         string
	ClientVersion string
	SinceTime     time.Time
	TraceID       string
	DBName        string                 // 分库
	TablePrefix   string                 // 分表
	Debug         bool                   // if debug user logger will very detailed
	FakeTime      string                 // faketime for debug mode user
	Extra         map[string]interface{} `json:"extra"`
}

type Context interface {
	Context() context.Context
	GinContext() *gin.Context

	Send(data interface{}, err error)
	SendOk(data ...interface{}) // SendOk(data interface{})
	SendErr(err error)
	SendErrCode(errcode int)
	SendParamErr(err ...error)
	SendInternalErr(err ...error)
	Stream(closer io.ReadCloser)
	HTML(tmpl string, data interface{})

	Bind(param interface{}) error
	BindJSON(param interface{}) error
	BindUri(param interface{}) error
	BindQuery(param interface{}) error
	BindHeader(obj interface{}) error
	Param(key string) string

	Next()
	Abort()
	AbortWithStatus(code int)
	AbortWithStatusJSON(code int, jsonObj interface{})

	GetHeader(key string) string
	Header(key, value string)
	Set(key string, value interface{})
	Get(key string) (interface{}, bool)

	GetClaim() *Claim
	SetClaim(claim *Claim)
}

type Controller interface {
	Register(route IRoutes)
}

type Engine interface {
	Run(clean func()) error
	Shutdown() error
}

type Err struct {
	Code         int      // 错误码
	HTTP         int      // http status code
	Msg          string   // error message
	Ref          []string // reference to error code
	MetricIgnore bool     // 是否忽略metric
}

type ErrResponse struct {
	Success bool   `json:"success" example:"false"`
	Trace   string `json:"trace,omitempty" example:"uuid"`
	Code    int    `json:"code" example:"400000000"`
	Msg     string `json:"msg" example:"error message"`
}

type HTTPConf struct {
	Enable         bool   `default:"true"`
	Mode           string `default:"release" opts:"release,debug,test"`
	BaseRoute      string `default:""`
	ColorConsole   bool   `default:"false"`
	Port           int    `default:"8080"`
	Host           string `default:"127.0.0.1"`
	ReadSecond     int    `default:"30"`
	WriteSecond    int    `default:"30"`
	ConnSecond     int    `default:"30"`
	ShutdownSecond int    ` default:"30" validate:"min=1,max=60"`
	TLS            TLS
	Metrics        Metrics
}

type HandlerFunc func(ctx Context)

type Health struct {
	Endpoint string `default:"/health"`
}

type IRoutes interface {
	Use(...HandlerFunc)
	Group(string, ...HandlerFunc) IRoutes

	Handle(string, string, ...HandlerFunc)
	Any(string, ...HandlerFunc)
	GET(string, ...HandlerFunc)
	POST(string, ...HandlerFunc)
	DELETE(string, ...HandlerFunc)
	PATCH(string, ...HandlerFunc)
	PUT(string, ...HandlerFunc)
	OPTIONS(string, ...HandlerFunc)
	HEAD(string, ...HandlerFunc)

	StaticFile(string, string)
	Static(string, string)
	StaticFS(string, http.FileSystem)

	Context() context.Context
}

type Metrics struct {
	Enable    bool   `default:"true"`
	Namespace string `default:""`
	Endpoint  string `default:"/metrics"`
}

type PageResponse struct {
	Page     int64       `json:"page" example:"1"`
	PageSize int64       `json:"page_size" example:"10"`
	Total    int64       `json:"total" example:"0"`
	Data     interface{} `json:"data"`
}

type PaginationResponse struct {
	Response
	Data PageResponse `json:"data"`
}

type RegisterRoute func(IRoutes)

type Response struct {
	Trace   string      `json:"trace,omitempty" example:"uuid"`
	Success bool        `json:"success" example:"true"`
	Code    int         `json:"code" example:"0"`
	Msg     string      `json:"msg" example:"ok"`
	Data    interface{} `json:"data"`
}

type TLS struct {
	Enable      bool   `default:"false"`
	LetsEncrypt bool   `default:"false"`
	CacheDir    string `default:"/var/cache/letsencrypt"`
	Domain      string `default:""`
	KeyFile     string
	CertFile    string
}