middleware

README

Middleware

The middleware package contains functions that are used as middleware on the server side.

Getting Started

package main

import (
	"fmt"
	"net/http"

	"github.com/gromey/proto-rest/logger"
	"github.com/gromey/proto-rest/middleware"
)

func main() {
	handlerFunc := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		if _, err := fmt.Fprintln(w, "Hello World!"); err != nil {
			panic(err)
		}
	})

	http.Handle("/example/", handlerFunc)

	h := middleware.Sequencer(
		http.DefaultServeMux,
		middleware.DumpHttp(logger.LevelTrace),
		middleware.Timer(logger.LevelInfo),
		middleware.PanicCatcher,
	)

	if err := http.ListenAndServe(":8080", h); err != nil {
		panic(err)
	}
}

Documentation

Index

• func AllowCORS(next http.Handler, opts *CORSOptions) http.Handler
• func DumpHttp(logLevel logger.Level) func(http.Handler) http.Handler
• func PanicCatcher(next http.Handler) http.Handler
• func Sequencer(baseHandler http.Handler, mws ...func(http.Handler) http.Handler) http.Handler
• func Timer(logLevel logger.Level) func(http.Handler) http.Handler
• type CORSOptions

Functions

func AllowCORS

func AllowCORS(next http.Handler, opts *CORSOptions) http.Handler

AllowCORS sets headers for CORS mechanism supports secure.

func DumpHttp

func DumpHttp(logLevel logger.Level) func(http.Handler) http.Handler

DumpHttp dumps the HTTP request and response, and prints out with logFunc.

func PanicCatcher

func PanicCatcher(next http.Handler) http.Handler

PanicCatcher handles panics in http.HandlerFunc.

func Sequencer

func Sequencer(baseHandler http.Handler, mws ...func(http.Handler) http.Handler) http.Handler

Sequencer chains middleware functions in a chain.

func Timer

func Timer(logLevel logger.Level) func(http.Handler) http.Handler

Timer measures the time taken by http.HandlerFunc.

Types

type CORSOptions

type CORSOptions struct {
	AllowedOrigins   []string // The origins that the server allows.
	AllowMethods     []string // List of methods that the server allows.
	AllowHeaders     []string // List of headers that the server allows.
	MaxAge           int      // Tells the browser how long (in seconds) to cache the response to the preflight request.
	AllowCredentials bool     // Allow browsers to expose the response to the external JavaScript code.
}

CORSOptions represents a functional option for configuring the CORS middleware.