http

Documentation

Index

• Variables
• func DocHandler(assets Assets) http.HandlerFunc
• func FileHandler(cfg *config.Config, database db.DB, assets Assets) http.HandlerFunc
• func HealthHandler(w http.ResponseWriter, _ *http.Request)
• func MetaHandler(cfg *config.Config) http.HandlerFunc
• func Pattern(r *http.Request) string
• func ProfileHandler(w http.ResponseWriter, r *http.Request)
• func ShouldSendRaw(r *http.Request) bool
• func WithLogger(next http.Handler) http.Handler
• func WithMetrics(next http.Handler) http.Handler
• func WithMiddleware(handler http.Handler, middlewares ...Middleware) http.Handler
• func WithRecover(next http.Handler) http.Handler
• func WithRequestID(next http.Handler) http.Handler
• type Assets
• type ContextKey
• type Middleware
• type Service
  • func New(cfg *config.Config, database db.DB, assets Assets) (*Service, error)
• type StaticAssets
  • func NewAssets(webFS fs.FS, docsFS fs.FS, readme []byte, extendHeadFile string) (*StaticAssets, error)
  • func (a *StaticAssets) CSS() []byte
  • func (a *StaticAssets) Doc(filename string) ([]byte, error)
  • func (a *StaticAssets) JS() []byte
  • func (a *StaticAssets) README() []byte
  • func (a *StaticAssets) Serve(w http.ResponseWriter, r *http.Request)
  • func (a *StaticAssets) Template() *template.Template

Variables

var DefaultMiddleware = []Middleware{
	WithRecover,
	WithMetrics,
	WithLogger,
	WithRequestID,
}

Functions

func DocHandler

func DocHandler(assets Assets) http.HandlerFunc

func FileHandler

func FileHandler(cfg *config.Config, database db.DB, assets Assets) http.HandlerFunc

func HealthHandler

func HealthHandler(w http.ResponseWriter, _ *http.Request)

func MetaHandler

func MetaHandler(cfg *config.Config) http.HandlerFunc

func Pattern

func Pattern(r *http.Request) string

func ProfileHandler

func ProfileHandler(w http.ResponseWriter, r *http.Request)

func ShouldSendRaw

func ShouldSendRaw(r *http.Request) bool

func WithLogger

func WithLogger(next http.Handler) http.Handler

WithLogger adds a request scoped logger to the request context.

func WithMetrics

func WithMetrics(next http.Handler) http.Handler

WithMetrics will record metrics for the request.

func WithMiddleware

func WithMiddleware(handler http.Handler, middlewares ...Middleware) http.Handler

func WithRecover

func WithRecover(next http.Handler) http.Handler

WithRecover will recover from any panics and log them.

func WithRequestID

func WithRequestID(next http.Handler) http.Handler

WithRequestID adds a unique request ID to the request context.

Types

type Assets

type Assets interface {
	Doc(filename string) ([]byte, error)
	Template() *template.Template
	Serve(w http.ResponseWriter, r *http.Request)
}

type ContextKey

type ContextKey string

const (
	RequestIDContextKey ContextKey = "request_id"

	RequestIDHeader = "X-Request-ID"
)

type Middleware

type Middleware func(next http.Handler) http.Handler

type Service

type Service struct {
	*http.Server
}

func New

func New(cfg *config.Config, database db.DB, assets Assets) (*Service, error)

type StaticAssets

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

func NewAssets

func NewAssets(webFS fs.FS, docsFS fs.FS, readme []byte, extendHeadFile string) (*StaticAssets, error)

NewAssets holds the templates, static content and minifies accordingly.

func (*StaticAssets) CSS

func (a *StaticAssets) CSS() []byte

func (*StaticAssets) Doc

func (a *StaticAssets) Doc(filename string) ([]byte, error)

func (*StaticAssets) JS

func (a *StaticAssets) JS() []byte

func (*StaticAssets) README

func (a *StaticAssets) README() []byte

func (*StaticAssets) Serve

func (a *StaticAssets) Serve(w http.ResponseWriter, r *http.Request)

func (*StaticAssets) Template

func (a *StaticAssets) Template() *template.Template