httprest

Documentation

Index

• type Option
  • func WithHTTPAddr(addr string) Option
  • func WithMiddlewares(mw []middleware.Middleware) Option
  • func WithRouter(r *http.ServeMux) Option
  • func WithTimeout(duration time.Duration) Option
• type Server
  • func New(ctx context.Context, opts ...Option) (*Server, error)
  • func (g *Server) Start()
  • func (g *Server) Status() error
  • func (g *Server) Stop() error

Types

type Option

type Option func(g *Server) error

Option is a http rest server functional parameter type.

func WithHTTPAddr

func WithHTTPAddr(addr string) Option

WithHTTPAddr sets the full address ( host and port ) of the server.

func WithMiddlewares

func WithMiddlewares(mw []middleware.Middleware) Option

WithMiddlewares sets the list of middlewares to be applied on routes.

func WithRouter

func WithRouter(r *http.ServeMux) Option

WithRouter sets the internal router of the server, this is required.

func WithTimeout

func WithTimeout(duration time.Duration) Option

WithTimeout allows changing the timeout value for API calls.

type Server

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

Server serves HTTP traffic.

func New

func New(ctx context.Context, opts ...Option) (*Server, error)

New returns a new instance of the Server.

func (*Server) Start

func (g *Server) Start()

Start the http rest service.

func (*Server) Status

func (g *Server) Status() error

Status of the HTTP server. Returns an error if this service is unhealthy.

func (*Server) Stop

func (g *Server) Stop() error

Stop the HTTP server with a graceful shutdown.