httpdebug

README

go-http-debug

go-http-debug is a set of middlewares that can be used to print information about requests and responses of a Go web server during development.

It's meant to be used as a toy/experiment, and as an aid to develop side projects.

Usage

For detailed usage read the Go documentation, as a summary, this library exposes a few middlewares:

stdout

Prints debugging information to stdout, supports two formats:

// RawStdout produces pretty printed output
handler = httpdebug.RawStdout(handler)

// JSONStdout prints a JSON structure representing the transaction
handler = httpdebug.JSONStdout(handler)

web

The web middleware starts a web server that serves a web UI.

A web interface with default values can be started with:

handler = httpdebug.WebUI(handler)

If you want to customize some of the defaults:

debug := httpdebug.NewWebUIHandler(
    httpdebug.WithAddress(":1234"),
    httpdebug.WithoutMessage(),
)

handler = debug.WebUI(handler)

License

GPL-3.0

Documentation

Index

• func JSONStdout(next http.HandlerFunc) http.HandlerFunc
• func RawStdout(next http.HandlerFunc) http.HandlerFunc
• func WebUI(next http.HandlerFunc) http.HandlerFunc
• func WithAddress(addr string) func(*WebUIHandler)
• func WithoutMessage() func(*WebUIHandler)
• type WebUIHandler
  • func NewWebUIHandler(opts ...func(*WebUIHandler)) *WebUIHandler
  • func (h *WebUIHandler) Wrap(next http.HandlerFunc) http.HandlerFunc

Functions

func JSONStdout

func JSONStdout(next http.HandlerFunc) http.HandlerFunc

func RawStdout

func RawStdout(next http.HandlerFunc) http.HandlerFunc

func WebUI

func WebUI(next http.HandlerFunc) http.HandlerFunc

func WithAddress

func WithAddress(addr string) func(*WebUIHandler)

func WithoutMessage

func WithoutMessage() func(*WebUIHandler)

Types

type WebUIHandler

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

func NewWebUIHandler

func NewWebUIHandler(opts ...func(*WebUIHandler)) *WebUIHandler

func (*WebUIHandler) Wrap

func (h *WebUIHandler) Wrap(next http.HandlerFunc) http.HandlerFunc