foxdebug

README

Convenient debug handler for fox.

Foxdebug is a small helper package for the Fox router, designed to provide detailed system and request information for debugging purposes. This package should only be used in a development environment as it may expose sensitive information.

Installation

go get -u github.com/tigerwill90/foxdebug

Usage

To use the foxdebug package, simply import it and register the DebugHandler to any route.

package main

import (
	"errors"
	"log"
	"net/http"

	"github.com/tigerwill90/fox"
	"github.com/tigerwill90/foxdebug"
)

func main() {
	f, err := fox.New(fox.DefaultOptions())
	if err != nil {
		panic(err)
	}
	f.MustHandle(http.MethodGet, "/debug", foxdebug.Handler())

	if err = http.ListenAndServe(":8080", f); err != nil && !errors.Is(err, http.ErrServerClosed) {
		log.Fatalln(err)
	}
}

License

This project is licensed under the MIT License - see the LICENSE file for details.

Documentation

Index

• func Handler() fox.HandlerFunc
• func HandlerWith(f *fox.Router) fox.HandlerFunc

Functions

func Handler

func Handler() fox.HandlerFunc

Handler returns a HandlerFunc that responds with detailed system, router and request information. This function may leak sensitive information and is only useful for debugging purposes, providing a comprehensive overview of the incoming request and the system it is running on.

func HandlerWith

func HandlerWith(f *fox.Router) fox.HandlerFunc

HandlerWith returns a HandlerFunc that responds with detailed system, router and request information using the provided router instance. This function may leak sensitive information and is only useful for debugging purposes, providing a comprehensive overview of the incoming request and the system it is running on.