{"id":13794023,"url":"https://github.com/gin-contrib/gzip","last_synced_at":"2025-06-13T18:39:36.846Z","repository":{"id":37334024,"uuid":"46012962","full_name":"gin-contrib/gzip","owner":"gin-contrib","description":"Gin middleware to enable GZIP support.","archived":false,"fork":false,"pushed_at":"2025-05-05T22:56:23.000Z","size":161,"stargazers_count":344,"open_issues_count":18,"forks_count":90,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-12T20:42:34.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gin-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-11T22:10:32.000Z","updated_at":"2025-04-30T10:59:03.000Z","dependencies_parsed_at":"2023-01-31T01:55:10.888Z","dependency_job_id":"32ad180b-0220-4fca-a298-b7f0a06fcbe9","html_url":"https://github.com/gin-contrib/gzip","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/gin-contrib/gzip","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fgzip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fgzip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fgzip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fgzip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gin-contrib","download_url":"https://codeload.github.com/gin-contrib/gzip/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fgzip/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259700055,"owners_count":22898375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T23:00:34.803Z","updated_at":"2025-06-13T18:39:36.779Z","avatar_url":"https://github.com/gin-contrib.png","language":"Go","readme":"# GZIP gin's middleware\n\n[![Run Tests](https://github.com/gin-contrib/gzip/actions/workflows/go.yml/badge.svg)](https://github.com/gin-contrib/gzip/actions/workflows/go.yml)\n[![codecov](https://codecov.io/gh/gin-contrib/gzip/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-contrib/gzip)\n[![Go Report Card](https://goreportcard.com/badge/github.com/gin-contrib/gzip)](https://goreportcard.com/report/github.com/gin-contrib/gzip)\n[![GoDoc](https://godoc.org/github.com/gin-contrib/gzip?status.svg)](https://godoc.org/github.com/gin-contrib/gzip)\n\nGin middleware to enable `GZIP` support.\n\n## Usage\n\nDownload and install it:\n\n```sh\ngo get github.com/gin-contrib/gzip\n```\n\nImport it in your code:\n\n```go\nimport \"github.com/gin-contrib/gzip\"\n```\n\nCanonical example:\n\n```go\npackage main\n\nimport (\n  \"fmt\"\n  \"net/http\"\n  \"time\"\n\n  \"github.com/gin-contrib/gzip\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  r.Use(gzip.Gzip(gzip.DefaultCompression))\n  r.GET(\"/ping\", func(c *gin.Context) {\n    c.String(http.StatusOK, \"pong \"+fmt.Sprint(time.Now().Unix()))\n  })\n\n  // Listen and Server in 0.0.0.0:8080\n  if err := r.Run(\":8080\"); err != nil {\n    log.Fatal(err)\n  }\n}\n```\n\n### Customized Excluded Extensions\n\n```go\npackage main\n\nimport (\n  \"fmt\"\n  \"net/http\"\n  \"time\"\n\n  \"github.com/gin-contrib/gzip\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  r.Use(gzip.Gzip(gzip.DefaultCompression, gzip.WithExcludedExtensions([]string{\".pdf\", \".mp4\"})))\n  r.GET(\"/ping\", func(c *gin.Context) {\n    c.String(http.StatusOK, \"pong \"+fmt.Sprint(time.Now().Unix()))\n  })\n\n  // Listen and Server in 0.0.0.0:8080\n  if err := r.Run(\":8080\"); err != nil {\n    log.Fatal(err)\n  }\n}\n```\n\n### Customized Excluded Paths\n\n```go\npackage main\n\nimport (\n  \"fmt\"\n  \"net/http\"\n  \"time\"\n\n  \"github.com/gin-contrib/gzip\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  r.Use(gzip.Gzip(gzip.DefaultCompression, gzip.WithExcludedPaths([]string{\"/api/\"})))\n  r.GET(\"/ping\", func(c *gin.Context) {\n    c.String(http.StatusOK, \"pong \"+fmt.Sprint(time.Now().Unix()))\n  })\n\n  // Listen and Server in 0.0.0.0:8080\n  if err := r.Run(\":8080\"); err != nil {\n    log.Fatal(err)\n  }\n}\n```\n\n### Customized Excluded Paths with Regex\n\n```go\npackage main\n\nimport (\n  \"fmt\"\n  \"net/http\"\n  \"time\"\n\n  \"github.com/gin-contrib/gzip\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  r.Use(gzip.Gzip(gzip.DefaultCompression, gzip.WithExcludedPathsRegexs([]string{\".*\"})))\n  r.GET(\"/ping\", func(c *gin.Context) {\n    c.String(http.StatusOK, \"pong \"+fmt.Sprint(time.Now().Unix()))\n  })\n\n  // Listen and Server in 0.0.0.0:8080\n  if err := r.Run(\":8080\"); err != nil {\n    log.Fatal(err)\n  }\n}\n```\n\n### Server Push\n\n```go\npackage main\n\nimport (\n  \"fmt\"\n  \"log\"\n  \"net/http\"\n  \"time\"\n\n  \"github.com/gin-contrib/gzip\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  r.Use(gzip.Gzip(gzip.DefaultCompression))\n  r.GET(\"/stream\", func(c *gin.Context) {\n    c.Header(\"Content-Type\", \"text/event-stream\")\n    c.Header(\"Connection\", \"keep-alive\")\n    for i := 0; i \u003c 10; i++ {\n      fmt.Fprintf(c.Writer, \"id: %d\\ndata: tick %d\\n\\n\", i, time.Now().Unix())\n      c.Writer.Flush()\n      time.Sleep(1 * time.Second)\n    }\n  })\n\n  // Listen and Server in 0.0.0.0:8080\n  if err := r.Run(\":8080\"); err != nil {\n    log.Fatal(err)\n  }\n}\n```\n","funding_links":[],"categories":["Middlewares","Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgin-contrib%2Fgzip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgin-contrib%2Fgzip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgin-contrib%2Fgzip/lists"}