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.

Gin's key features are:

• Zero allocation router
• Speed
• Middleware support
• Crash-free
• JSON validation
• Route grouping
• Error management
• Built-in rendering
• Extensible

Gin requires Go version 1.21 or above.

With Go's module support, go [build|run|test] automatically fetches the necessary dependencies when you add the import in your code:

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

Alternatively, use go get:

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

A basic example:

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")
}

To run the code, use the go run command, like:

$ go run example.go

Then visit 0.0.0.0:8080/ping in your browser to see the response!

Learn and practice with the Gin Quick Start, which includes API examples and builds tag.

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

See the API documentation on go.dev.

The documentation is also available on gin-gonic.com in several languages:

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

• Tutorial: Developing a RESTful API with Go and Gin

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

• (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.

Here are some awesome projects that are using the Gin web framework.

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

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

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