http

Documentation

Index

• func AccessLogger() gin.HandlerFunc
• func JSONAppErrorHandler() gin.HandlerFunc
• type HealthcheckController
  • func NewHealthcheckController() *HealthcheckController
  • func (ctrl *HealthcheckController) Register(routerGroup *gin.RouterGroup)
• type Server
  • func NewServer() *Server
  • func (server *Server) Run() error
  • func (server *Server) Setup(config *config.AppConfiguration, controllers *server.Controllers)

Functions

func AccessLogger

func AccessLogger() gin.HandlerFunc

AccessLogger retrieves a new middleware that logs the GIN requests.

func JSONAppErrorHandler

func JSONAppErrorHandler() gin.HandlerFunc

JSONAppErrorHandler is the middleware handling the overall error handling mechanism.

Types

type HealthcheckController

type HealthcheckController struct {
}

HealthcheckController handles any such check operations.

func NewHealthcheckController

func NewHealthcheckController() *HealthcheckController

NewHealthcheckController retrieves a new controller that handles any health check requests.

func (*HealthcheckController) Register

func (ctrl *HealthcheckController) Register(routerGroup *gin.RouterGroup)

Register this controller to the provided group.

type Server

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

Server structure that encapsulates all related data.

func NewServer

func NewServer() *Server

NewServer creates a new bare-boned application server.

func (*Server) Run

func (server *Server) Run() error

Run starts the application server based on configuration settings.

func (*Server) Setup

func (server *Server) Setup(config *config.AppConfiguration, controllers *server.Controllers)

Setup prepares the server but does not starts it.