web

package

v1.2.2 Latest Latest Go to latest Published: Feb 2, 2023 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

REST server with Web Socket endpoint and Static files endpoints support

This section is empty.

This section is empty.

This section is empty.

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

func NewWebServer(port string) *WebServer

NewWebServer is a factory method to create a new instance of Rest Server

func (s *WebServer) AddHandler(path string, handler http.HandlerFunc) *WebServer

AddHandler adds path handler to the server

func (s *WebServer) AddRestEntries(list ...rest.RestEntry) *WebServer

AddRestEntries adds list of REST entries to the server

func (s *WebServer) AddStaticEntries(list ...rest.StaticFilesEntry) *WebServer

AddStaticEntries adds list of static file entries to the server

func (s *WebServer) AddWebSocketEntries(list ...socket.WSEndpointConfig) *WebServer

AddWebSocketEntries adds list of Web Socket entries to the server

func (s *WebServer) EnableMetrics(enable bool) *WebServer

EnableMetrics enables/disables the /metrics endpoint

func (s *WebServer) RestHandlerAdaptor(adaptorFunc rest.RestHandlerAdaptorFunc) *WebServer

RestHandlerAdaptor injects external adaptor function to perform request pre-processing

func (s *WebServer) Start() (err error)

Start configure and start the web server