webservice

README

webservice

Golang Microservice helper based on gorilla/mux

Documentation

Index

• Variables
• func AllowAllCorsMiddleware(h http.Handler) http.Handler
• type AppHandler
  • func (ah AppHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type AppHandlerWithUserID
  • func (ah AppHandlerWithUserID) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type BuildInfo
• type Config
• type ConfigureRouterHandler
• type GelfFormatter
  • func (f *GelfFormatter) Format(entry *logrus.Entry) ([]byte, error)
• type ServerStatus
  • func NewServerStatus(bi BuildInfo) *ServerStatus
• type Timeouts
• type WebService
  • func New(obj WebServiceObject, options ...WebServiceOption) WebService
• type WebServiceBase
  • func (s *WebServiceBase) Start() (err error)
• type WebServiceBeforeEnd
• type WebServiceBeforeStart
• type WebServiceGetHTTPHandlerObsolete
• type WebServiceGetStatusHandler
• type WebServiceObject
• type WebServiceOption
  • func WithBuildInfo(bi BuildInfo) WebServiceOption
  • func WithIdleTimeout(timeout time.Duration) WebServiceOption
  • func WithReadTimeout(timeout time.Duration) WebServiceOption
  • func WithTimeouts(write, read, idle time.Duration) WebServiceOption
  • func WithWriteTimeout(timeout time.Duration) WebServiceOption
• type WebServicePreparePFlags

Variables

var (
	Version   string
	BuildTime string
	CommitSHA string
)

Functions

func AllowAllCorsMiddleware

func AllowAllCorsMiddleware(h http.Handler) http.Handler

AllowAllCorsMiddleware returns middleware function that can be used in router.Use()

Types

type AppHandler

type AppHandler func(w http.ResponseWriter, r *http.Request) error

AppHandler is handler that take care of content type and error handling

func (AppHandler) ServeHTTP

func (ah AppHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Satisfies the http.Handler interface

type AppHandlerWithUserID

type AppHandlerWithUserID func(userID string, w http.ResponseWriter, r *http.Request) error

AppHandlerWithUserID is handler that take care of userID, content type and error handling

func (AppHandlerWithUserID) ServeHTTP

func (ah AppHandlerWithUserID) ServeHTTP(w http.ResponseWriter, r *http.Request)

Satisfies the http.Handler interface

type BuildInfo

type BuildInfo struct {
	Name          string `json:"name,omitempty"`
	Version       string `json:"version,omitempty"`
	BuildTime     string `json:"build_time,omitempty"`
	CommitSHA     string `json:"commit_sha,omitempty"`
	PreferLdflags bool   `json:"-"`
}

BuildInfo represents build information for the service

type Config

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

Config holds all configuration for WebService

type ConfigureRouterHandler

type ConfigureRouterHandler interface {
	ConfigureRouter(router *mux.Router) (handler http.Handler, err error)
}

ConfigureRouterHandler ...

type GelfFormatter

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

GelfFormatter ...

func (*GelfFormatter) Format

func (f *GelfFormatter) Format(entry *logrus.Entry) ([]byte, error)

Format formats the log entry to GELF JSON

type ServerStatus

type ServerStatus struct {
	Running   bool   `json:"running,omitempty"`
	Process   string `json:"process,omitempty"`
	Pid       int    `json:"pid,omitempty"`
	StripPath string `json:"strip_path,omitempty"`
	JwksURL   string `json:"jwks_url,omitempty"`
	BuildInfo
}

ServerStatus return actual state and process data so you can test with url/state the correct installation of microservice

func NewServerStatus

func NewServerStatus(bi BuildInfo) *ServerStatus

NewServerStatus create default service status

type Timeouts

type Timeouts struct {
	WriteTimeout time.Duration
	ReadTimeout  time.Duration
	IdleTimeout  time.Duration
}

type WebService

type WebService interface {
	Start() (err error) // Start service
}

WebService ...

func New

func New(obj WebServiceObject, options ...WebServiceOption) WebService

New creates new web service object

type WebServiceBase

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

WebServiceBase ...

func (*WebServiceBase) Start

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

Start starts service

type WebServiceBeforeEnd

type WebServiceBeforeEnd interface {
	BeforeEnd()
}

WebServiceBeforeEnd ...

type WebServiceBeforeStart

type WebServiceBeforeStart interface {
	BeforeStart() (err error)
}

WebServiceBeforeStart ...

type WebServiceGetHTTPHandlerObsolete

type WebServiceGetHTTPHandlerObsolete interface {
	GetHTTPHandler() (handler http.Handler, err error)
}

WebServiceGetHTTPHandlerObsolete ...

type WebServiceGetStatusHandler

type WebServiceGetStatusHandler interface {
	GetServerStatus() (status interface{})
}

WebServiceGetStatusHandler ...

type WebServiceObject

type WebServiceObject interface {
}

WebServiceObject ...

type WebServiceOption

type WebServiceOption func(*Config)

WebServiceOption defines a function type for setting options

func WithBuildInfo

func WithBuildInfo(bi BuildInfo) WebServiceOption

WithBuildInfo sets the build information

func WithIdleTimeout

func WithIdleTimeout(timeout time.Duration) WebServiceOption

WithIdleTimeout sets the idle timeout

func WithReadTimeout

func WithReadTimeout(timeout time.Duration) WebServiceOption

WithReadTimeout sets the read timeout

func WithTimeouts

func WithTimeouts(write, read, idle time.Duration) WebServiceOption

WithTimeouts sets all timeout values at once

func WithWriteTimeout

func WithWriteTimeout(timeout time.Duration) WebServiceOption

WithWriteTimeout sets the write timeout

type WebServicePreparePFlags

type WebServicePreparePFlags interface {
	PreparePFlags() (err error)
}

WebServicePreparePFlags ...