server

Documentation

Index

• func NewRouter(routes ...Route) http.Handler
• func RecovererMiddleware(next http.Handler) http.Handler
• func RequestID(req *http.Request) uuid.UUID
• func RequestIDMiddleware(next http.Handler) http.Handler
• type Config
• type RequestLogEntry
  • func (rle RequestLogEntry) Panic(val interface{}, stack []byte)
  • func (rle RequestLogEntry) Write(status, bytes int, elapsed time.Duration)
• type RequestLogger
  • func (rl RequestLogger) NewLogEntry(req *http.Request) middleware.LogEntry
• type Route
• type Server
  • func New(handler http.Handler, config Config) *Server
  • func (s *Server) Serve() error

Functions

func NewRouter

func NewRouter(routes ...Route) http.Handler

NewRouter creates a http.Handler to route endpoints for a JSON API.

func RecovererMiddleware

func RecovererMiddleware(next http.Handler) http.Handler

RecovererMiddleware recovers panics in an HTTP handler and logs the panic via Chi.

func RequestID

func RequestID(req *http.Request) uuid.UUID

RequestID retrieves the request id from the context.

func RequestIDMiddleware

func RequestIDMiddleware(next http.Handler) http.Handler

RequestIDMiddleware creates random request ids and adds them to the request context.

Types

type Config

type Config struct {
	Addr string
}

type RequestLogEntry

type RequestLogEntry struct {
	Request *http.Request
}

RequestLogEntry implements Chi middleware.LogEntry to log requests and panics via Apex log.

func (RequestLogEntry) Panic

func (rle RequestLogEntry) Panic(val interface{}, stack []byte)

func (RequestLogEntry) Write

func (rle RequestLogEntry) Write(status, bytes int, elapsed time.Duration)

type RequestLogger

type RequestLogger struct{}

RequestLogger implements Chi middleware.LogFormatter to log requests via Apex log.

func (RequestLogger) NewLogEntry

func (rl RequestLogger) NewLogEntry(req *http.Request) middleware.LogEntry

type Route

type Route struct {
	Method      string
	Path        string
	Middlewares []func(http.Handler) http.Handler
	Handler     http.HandlerFunc
}

Route is a single route that has a handler and a list of middleware for the handler.

type Server

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

Server implements a graceful HTTP server.

func New

func New(handler http.Handler, config Config) *Server

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the HTTP server and serves requests until SIGINT or SIGTERM.