popaprozac / gin-brotli

Brotli gin's middleware

Brotli gin's middleware

Gin middleware to enable Brotli support.

NOTE: this repo is an adaptation of how gzip middleware is implemented. I'll try to add new features.

Requirements

Install Brotli, see here.

Install brotli package for go (cbrotli). Copy github.com/google/brotli/tree/master/go/cbrotli package into GOPATH/ directory

Install

go get github.com/anargu/gin-brotli

How to use

package main

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

    brotli "github.com/anargu/gin-brotli"
    "github.com/gin-gonic/gin"
)

func main() {
    r := gin.Default()
    r.Use(brotli.Brotli(brotli.DefaultCompression))
    r.GET("/hello", func(c *gin.Context) {
        c.String(http.StatusOK, fmt.Sprintf("World at %s", time.Now()))
    })

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

TODO

• Add like a fallback: If brotli is not supported in browser then the request will be handled by gzip compression. And if it's not supported by the browser yet, the request is going to be send as is (without compression).

• Checking if using sync.Pool is needed to improve performance. Check benchmark test.