httpserver

Documentation

Index

• Variables
• func GetLoggerFromContext(ctx *gin.Context) *log.Entry
• func SetCors(router *gin.Engine, allowedOrigins []string)
• type ContextKey
  • func (ck ContextKey) String() string
• type HttpServer
  • func NewHttpServer(config *domain.HttpServerConfig) *HttpServer
  • func (hs *HttpServer) CreateLoggerForRequest(ctx *gin.Context)
  • func (hs *HttpServer) CreateMetricsForRequest(ctx *gin.Context)
  • func (hs *HttpServer) GetCorrelationID(ctx *gin.Context) string
  • func (gs *HttpServer) GetPath(ctx *gin.Context) string
  • func (gs *HttpServer) LogRequest(c *gin.Context)
  • func (gs *HttpServer) MapHttpStatusToLoggingLevel(ctx *gin.Context) logrus.Level
  • func (gs *HttpServer) ProfileNextRequest(ctx *gin.Context) time.Duration
  • func (hs *HttpServer) Reply(ctx *gin.Context, body interface{})
  • func (hs *HttpServer) ReplyWithError(ctx *gin.Context, err error)
  • func (hs *HttpServer) RequireCorrelationID(ctx *gin.Context)
  • func (hs *HttpServer) RequireRequestID(ctx *gin.Context)
  • func (gs *HttpServer) Run() error
• type Response

Variables

var HeaderXCorrelationId = "X-Correlation-ID"

var HeaderXRequestId = "X-Request-ID"

Functions

func GetLoggerFromContext

func GetLoggerFromContext(ctx *gin.Context) *log.Entry

func SetCors

func SetCors(router *gin.Engine, allowedOrigins []string)

Types

type ContextKey

type ContextKey struct {
	// contains filtered or unexported fields
}

func (ContextKey) String

func (ck ContextKey) String() string

type HttpServer

type HttpServer struct {
	Gin *gin.Engine
	// contains filtered or unexported fields
}

func NewHttpServer

func NewHttpServer(config *domain.HttpServerConfig) *HttpServer

func (*HttpServer) CreateLoggerForRequest

func (hs *HttpServer) CreateLoggerForRequest(ctx *gin.Context)

func (*HttpServer) CreateMetricsForRequest

func (hs *HttpServer) CreateMetricsForRequest(ctx *gin.Context)

func (*HttpServer) GetCorrelationID

func (hs *HttpServer) GetCorrelationID(ctx *gin.Context) string

func (*HttpServer) GetPath

func (gs *HttpServer) GetPath(ctx *gin.Context) string

func (*HttpServer) LogRequest

func (gs *HttpServer) LogRequest(c *gin.Context)

func (*HttpServer) MapHttpStatusToLoggingLevel

func (gs *HttpServer) MapHttpStatusToLoggingLevel(ctx *gin.Context) logrus.Level

func (*HttpServer) ProfileNextRequest

func (gs *HttpServer) ProfileNextRequest(ctx *gin.Context) time.Duration

func (*HttpServer) Reply

func (hs *HttpServer) Reply(ctx *gin.Context, body interface{})

func (*HttpServer) ReplyWithError

func (hs *HttpServer) ReplyWithError(ctx *gin.Context, err error)

func (*HttpServer) RequireCorrelationID

func (hs *HttpServer) RequireCorrelationID(ctx *gin.Context)

func (*HttpServer) RequireRequestID

func (hs *HttpServer) RequireRequestID(ctx *gin.Context)

func (*HttpServer) Run

func (gs *HttpServer) Run() error

type Response

type Response struct {
	StatusCode int `json:"status"`

	Body  interface{}           `json:"body,omitempty"`
	Error *domain.ResponseError `json:"error,omitempty"`

	RequestId string `json:"requestId,omitempty"`
	ContextId string `json:"contextId,omitempty"`
}