httprouter

Documentation

Overview

Package httprouter is a helper package to get a httprouter compatible middleware.

Example (HttprouterMiddlewareByHandler)

HTTPRouterMiddlewareByHandler shows how you would create a default middleware factory and use it to create a httprouter compatible middleware setting by handler instead of main router.

package main

import (
	"log"
	"net/http"

	"github.com/julienschmidt/httprouter"
	"github.com/prometheus/client_golang/prometheus/promhttp"

	metrics "github.com/slok/go-http-metrics/metrics/prometheus"
	"github.com/slok/go-http-metrics/middleware"

	httproutermiddleware "github.com/slok/go-http-metrics/middleware/httprouter"
)

func main() {
	// Create our handler.
	myHandler := func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
		id := p.ByName("id")
		w.WriteHeader(http.StatusOK)
		_, _ = w.Write([]byte("hello world! " + id))
	}

	// Create our router.
	r := httprouter.New()

	// Create our middleware factory with the default settings.
	mdlw := middleware.New(middleware.Config{
		Recorder: metrics.NewRecorder(metrics.Config{}),
	})
	// Add the middleware.
	r.GET("/test/:id", httproutermiddleware.Handler("/test/:id", myHandler, mdlw))
	r.GET("/test2/:id", httproutermiddleware.Handler("/test2/:id", myHandler, mdlw))

	// Serve metrics from the default prometheus registry.
	log.Printf("serving metrics at: %s", ":8081")
	go func() {
		_ = http.ListenAndServe(":8081", promhttp.Handler())
	}()

	// Serve our handler.
	log.Printf("listening at: %s", ":8080")
	if err := http.ListenAndServe(":8080", r); err != nil {
		log.Panicf("error while serving: %s", err)
	}
}

Example (HttprouterMiddlewareOnRouter)

HTTPRouterMiddlewareOnRouter shows how you would create a default middleware factory and use it to wrapon httprouter Router (that satisfies http.Handler interface).

package main

import (
	"log"
	"net/http"

	"github.com/julienschmidt/httprouter"
	"github.com/prometheus/client_golang/prometheus/promhttp"

	metrics "github.com/slok/go-http-metrics/metrics/prometheus"
	"github.com/slok/go-http-metrics/middleware"

	stdmiddleware "github.com/slok/go-http-metrics/middleware/std"
)

func main() {
	// Create our handler.
	myHandler := func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
		id := p.ByName("id")
		w.WriteHeader(http.StatusOK)
		_, _ = w.Write([]byte("hello world! " + id))
	}

	// Create our router and add the middleware.
	r := httprouter.New()

	// Create our middleware factory with the default settings.
	mdlw := middleware.New(middleware.Config{
		Recorder: metrics.NewRecorder(metrics.Config{}),
	})

	r.GET("/test/:id", myHandler)
	r.GET("/test2/:id", myHandler)

	// Serve metrics from the default prometheus registry.
	log.Printf("serving metrics at: %s", ":8081")
	go func() {
		_ = http.ListenAndServe(":8081", promhttp.Handler())
	}()

	// Wrap the router with the middleware.
	h := stdmiddleware.Handler("", mdlw, r)

	// Serve our handler.
	log.Printf("listening at: %s", ":8080")
	if err := http.ListenAndServe(":8080", h); err != nil {
		log.Panicf("error while serving: %s", err)
	}
}

Index

• func Handler(handlerID string, next httprouter.Handle, m middleware.Middleware) httprouter.Handle

Examples

• Package (HttprouterMiddlewareByHandler)
• Package (HttprouterMiddlewareOnRouter)

Functions

func Handler

func Handler(handlerID string, next httprouter.Handle, m middleware.Middleware) httprouter.Handle

Handler returns a httprouter.Handler measuring middleware.