Gin is a web framework written in Go. It features a martini-like API with performance that is up to 40 times faster thanks to httprouter. If you need performance and good productivity, you will love Gin.

The key features of Gin are:

• Zero allocation router
• Fast
• Middleware support
• Crash-free
• JSON validation
• Routes grouping
• Error management
• Rendering built-in
• Extendable

• Go: any one of the three latest major releases (we test it with these).

With Go module support, simply add the following import

import "github.com/gin-gonic/gin"

to your code, and then go [build|run|test] will automatically fetch the necessary dependencies.

Otherwise, run the following Go command to install the gin package:

$ go get -u github.com/gin-gonic/gin

First you need to import Gin package for using Gin, one simplest example likes the follow example.go:

package main

import (
  "net/http"

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

func main() {
  r := gin.Default()
  r.GET("/ping", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
      "message": "pong",
    })
  })
  r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}

And use the Go command to run the demo:

# run example.go and visit 0.0.0.0:8080/ping on browser
$ go run example.go

Learn and practice more examples, please read the Gin Quick Start which includes API examples and builds tag.

A number of ready-to-run examples demonstrating various use cases of Gin on the Gin examples repository.

See API documentation and descriptions for package.

All documentation is available on the Gin website.

• English
• 简体中文
• 繁體中文
• 日本語
• Español
• 한국어
• Turkish
• Persian

A curated list of awesome Gin framework.

• Tutorial: Developing a RESTful API with Go and Gin

Gin uses a custom version of HttpRouter, see all benchmarks details.

• (1): Total Repetitions achieved in constant time, higher means more confident result
• (2): Single Repetition Duration (ns/op), lower is better
• (3): Heap Memory (B/op), lower is better
• (4): Average Allocations per Repetition (allocs/op), lower is better

You can find many useful Gin middlewares at gin-contrib.

Awesome project lists using Gin web framework.

• gorush: A push notification server written in Go.
• fnproject: The container native, cloud agnostic serverless platform.
• photoprism: Personal photo management powered by Go and Google TensorFlow.
• lura: Ultra performant API Gateway with middlewares.
• picfit: An image resizing server written in Go.
• dkron: Distributed, fault tolerant job scheduling system.

Gin is the work of hundreds of contributors. We appreciate your help!

Please see CONTRIBUTING for details on submitting patches and the contribution workflow.