api

Documentation

Index

• type Server
  • func NewServer(e *gin.Engine) *Server
  • func (s *Server) Setup()
  • func (s *Server) WithController(c *internal.Controller)
  • func (s *Server) WithVerboseRequestLogging()

Types

type Server

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

Server hold the gin engine and any clients we need for the API.

func NewServer

func NewServer(e *gin.Engine) *Server

NewServer returns a new instance of Server.

func (*Server) Setup

func (s *Server) Setup()

Setup sets any global middlewares then initializes the API.

func (*Server) WithController

func (s *Server) WithController(c *internal.Controller)

WithController sets the internal controller instance for the server.

func (*Server) WithVerboseRequestLogging

func (s *Server) WithVerboseRequestLogging()

WithVerboseRequestLogging sets the server to use verbose request logging.