gin-cbrotli

Google Brotli Gin Middleware

Dependency

Debian/Ubuntu

sudo apt-get install libbrotli-dev

RHEL/CentOS

yum install brotli-devel

Alpine

apk add brotli-dev

MacOS (with homebrew)

brew install brotli

Windows (with msys2)

pacman -S mingw-w64-x86_64-brotli

OTHERS

Usage

Download and install it:

go get github.com/freyo/gin-cbrotli

Import it in your code:

import "github.com/freyo/gin-cbrotli"

Canonical example:

package main

import (
	"fmt"
	"net/http"
	"time"

	"github.com/freyo/gin-cbrotli"
	"github.com/gin-gonic/gin"
	"github.com/google/brotli/go/cbrotli"
)

func main() {
	r := gin.Default()
	r.Use(brotli.Brotli(cbrotli.WriterOptions{Quality: 5}))
	r.GET("/ping", func(c *gin.Context) {
		c.String(http.StatusOK, "pong "+fmt.Sprint(time.Now().Unix()))
	})

	// Listen and Server in 0.0.0.0:8080
	r.Run(":8080")
}

Work with Gzip example:

package main

import (
	"fmt"
	"net/http"
	"strings"
	"time"

	"github.com/freyo/gin-cbrotli"
	"github.com/gin-contrib/gzip"
	"github.com/gin-gonic/gin"
	"github.com/google/brotli/go/cbrotli"
)

func main() {
	r := gin.Default()
	r.Use(func(context *gin.Context) {
		ae := context.Request.Header.Get("Accept-Encoding")
		switch true {
		case strings.Contains(ae, "br"):
			context.Request.Header.Set("Accept-Encoding", "br")
		case strings.Contains(ae, "gzip"):
			context.Request.Header.Set("Accept-Encoding", "gzip")
		}
		context.Next()
	})
	r.Use(gzip.Gzip(gzip.DefaultCompression))
	r.Use(brotli.Brotli(cbrotli.WriterOptions{Quality: 5}))
	r.GET("/ping", func(c *gin.Context) {
		c.String(http.StatusOK, "pong "+fmt.Sprint(time.Now().Unix()))
	})

	// Listen and Server in 0.0.0.0:8080
	r.Run(":8080")
}