webserver

README

go-webserver

This is the basic structure I use when using Echo for creating a webserver.

Documentation

Index

• type ErrorResponse
• type Module
• type Server
  • func New() *Server
  • func (server *Server) Register(modules ...Module)
  • func (server *Server) Start() error
  • func (server *Server) Stop()

Types

type ErrorResponse

type ErrorResponse struct {
	XMLName xml.Name `json:"-"`
	Error   string   `json:"error" xml:"message"`
}

ErrorResponse defines a generic error response for a web request

type Module

type Module interface {
	Register(router *echo.Echo) // The function which registers the endpoints on the router
	Start()                     // Executed when the server starts
	Stop()                      // Executed when the server stops
}

Module defines a server module

type Server

type Server struct {
	DefaultPort         string
	PrintRoutes         bool
	JobQueuePoolSize    int
	JobQueueConcurrency int
	// contains filtered or unexported fields
}

Server is an abstraction of a webserver

func New

func New() *Server

New returns a new Server instacce

func (*Server) Register

func (server *Server) Register(modules ...Module)

Register registers the modules on the main router

func (*Server) Start

func (server *Server) Start() error

Start starts the webserver on the indicated port

func (*Server) Stop

func (server *Server) Stop()

Stop stops the server and performs the shutdown action for each module