mirror of https://github.com/gin-gonic/gin.git
586 lines
16 KiB
Markdown
586 lines
16 KiB
Markdown
#Gin Web Framework [](https://travis-ci.org/gin-gonic/gin) [](https://coveralls.io/r/gin-gonic/gin?branch=master)
|
|
|
|
[](https://godoc.org/github.com/gin-gonic/gin) [](https://gitter.im/gin-gonic/gin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
Gin is a web framework written in Golang. It features a martini-like API with much better performance, up to 40 times faster thanks to [httprouter](https://github.com/julienschmidt/httprouter). If you need performance and good productivity, you will love Gin.
|
|
|
|
|
|
|
|
```
|
|
$ cat test.go
|
|
```
|
|
```go
|
|
package main
|
|
|
|
import "github.com/gin-gonic/gin"
|
|
|
|
func main() {
|
|
r := gin.Default()
|
|
r.GET("/ping", func(c *gin.Context) {
|
|
c.String(200, "pong")
|
|
})
|
|
r.Run(":8080") // listen and serve on 0.0.0.0:8080
|
|
}
|
|
```
|
|
|
|
## Benchmarks
|
|
|
|
Comparision with the second fastest mutex: echo.
|
|
Gin uses a custom version of [HttpRouter](https://github.com/julienschmidt/httprouter)
|
|
|
|
[See all benchmarks](/BENCHMARKS.md)
|
|
|
|
|
|
```
|
|
BenchmarkEcho_Param 10000000 129 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_Param 10000000 130 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_Param5 5000000 258 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_Param5 5000000 221 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_Param20 2000000 690 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_Param20 3000000 542 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_ParamWrite 5000000 243 ns/op 8 B/op 1 allocs/op
|
|
BenchmarkGin_ParamWrite 5000000 324 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GithubStatic 10000000 170 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GithubStatic 10000000 157 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GithubParam 5000000 296 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GithubParam 5000000 250 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GithubAll 30000 59623 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GithubAll 30000 51971 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GPlusStatic 10000000 127 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GPlusStatic 20000000 123 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GPlusParam 10000000 173 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GPlusParam 10000000 168 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GPlus2Params 5000000 238 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GPlus2Params 10000000 209 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_GPlusAll 500000 2934 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_GPlusAll 500000 2564 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_ParseStatic 10000000 131 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_ParseStatic 10000000 128 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_ParseParam 10000000 143 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_ParseParam 10000000 138 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_Parse2Params 10000000 181 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_Parse2Params 10000000 164 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_ParseAll 300000 5227 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_ParseAll 300000 4734 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkEcho_StaticAll 50000 40169 ns/op 0 B/op 0 allocs/op
|
|
BenchmarkGin_StaticAll 50000 33080 ns/op 0 B/op 0 allocs/op
|
|
```
|
|
|
|
|
|
##Gin v1. stable
|
|
|
|
- [x] Zero allocation router.
|
|
- [x] Still the fastest http router and framework. From routing to writing.
|
|
- [x] Complete suite of unit tests
|
|
- [x] Battle tested
|
|
- [x] API frozen, new releases will not break your code.
|
|
|
|
|
|
## Start using it
|
|
1. Download and install it:
|
|
|
|
```sh
|
|
go get github.com/gin-gonic/gin
|
|
```
|
|
2. Import it in your code:
|
|
|
|
```go
|
|
import "github.com/gin-gonic/gin"
|
|
```
|
|
|
|
##API Examples
|
|
|
|
#### Using GET, POST, PUT, PATCH, DELETE and OPTIONS
|
|
|
|
```go
|
|
func main() {
|
|
// Creates a gin router with default middlewares:
|
|
// logger and recovery (crash-free) middlewares
|
|
router := gin.Default()
|
|
|
|
router.GET("/someGet", getting)
|
|
router.POST("/somePost", posting)
|
|
router.PUT("/somePut", putting)
|
|
router.DELETE("/someDelete", deleting)
|
|
router.PATCH("/somePatch", patching)
|
|
router.HEAD("/someHead", head)
|
|
router.OPTIONS("/someOptions", options)
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
#### Parameters in path
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
|
|
// This handler will match /user/john but will not match neither /user/ or /user
|
|
router.GET("/user/:name", func(c *gin.Context) {
|
|
name := c.Param("name")
|
|
c.String(http.StatusOK, "Hello %s", name)
|
|
})
|
|
|
|
// However, this one will match /user/john/ and also /user/john/send
|
|
// If no other routers match /user/john, it will redirect to /user/join/
|
|
router.GET("/user/:name/*action", func(c *gin.Context) {
|
|
name := c.Param("name")
|
|
action := c.Param("action")
|
|
message := name + " is " + action
|
|
c.String(http.StatusOK, message)
|
|
})
|
|
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
#### Querystring parameters
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
|
|
// Query string parameters are parsed using the existing underlying request object.
|
|
// The request responds to a url matching: /welcome?firstname=Jane&lastname=Doe
|
|
router.GET("/welcome", func(c *gin.Context) {
|
|
firstname := c.DefaultQuery("firstname", "Guest")
|
|
lastname := c.Query("lastname") // shortcut for c.Request.URL.Query().Get("lastname")
|
|
|
|
c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
|
|
})
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
### Multipart/Urlencoded Form
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
|
|
router.POST("/form_post", func(c *gin.Context) {
|
|
message := c.PostForm("message")
|
|
nick := c.DefaultPostForm("nick", "anonymous")
|
|
|
|
c.JSON(200, gin.H{
|
|
"status": "posted",
|
|
"message": message,
|
|
})
|
|
})
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
#### Grouping routes
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
|
|
// Simple group: v1
|
|
v1 := router.Group("/v1")
|
|
{
|
|
v1.POST("/login", loginEndpoint)
|
|
v1.POST("/submit", submitEndpoint)
|
|
v1.POST("/read", readEndpoint)
|
|
}
|
|
|
|
// Simple group: v2
|
|
v2 := router.Group("/v2")
|
|
{
|
|
v2.POST("/login", loginEndpoint)
|
|
v2.POST("/submit", submitEndpoint)
|
|
v2.POST("/read", readEndpoint)
|
|
}
|
|
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
|
|
#### Blank Gin without middlewares by default
|
|
|
|
Use
|
|
|
|
```go
|
|
r := gin.New()
|
|
```
|
|
instead of
|
|
|
|
```go
|
|
r := gin.Default()
|
|
```
|
|
|
|
|
|
#### Using middlewares
|
|
```go
|
|
func main() {
|
|
// Creates a router without any middleware by default
|
|
r := gin.New()
|
|
|
|
// Global middlewares
|
|
r.Use(gin.Logger())
|
|
r.Use(gin.Recovery())
|
|
|
|
// Per route middlewares, you can add as many as you desire.
|
|
r.GET("/benchmark", MyBenchLogger(), benchEndpoint)
|
|
|
|
// Authorization group
|
|
// authorized := r.Group("/", AuthRequired())
|
|
// exactly the same than:
|
|
authorized := r.Group("/")
|
|
// per group middlewares! in this case we use the custom created
|
|
// AuthRequired() middleware just in the "authorized" group.
|
|
authorized.Use(AuthRequired())
|
|
{
|
|
authorized.POST("/login", loginEndpoint)
|
|
authorized.POST("/submit", submitEndpoint)
|
|
authorized.POST("/read", readEndpoint)
|
|
|
|
// nested group
|
|
testing := authorized.Group("testing")
|
|
testing.GET("/analytics", analyticsEndpoint)
|
|
}
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
r.Run(":8080")
|
|
}
|
|
```
|
|
|
|
#### Model binding and validation
|
|
|
|
To bind a request body into a type, use model binding. We currently support binding of JSON, XML and standard form values (foo=bar&boo=baz).
|
|
|
|
Note that you need to set the corresponding binding tag on all fields you want to bind. For example, when binding from JSON, set `json:"fieldname"`.
|
|
|
|
When using the Bind-method, Gin tries to infer the binder depending on the Content-Type header. If you are sure what you are binding, you can use BindWith.
|
|
|
|
You can also specify that specific fields are required. If a field is decorated with `binding:"required"` and has a empty value when binding, the current request will fail with an error.
|
|
|
|
```go
|
|
// Binding from JSON
|
|
type LoginJSON struct {
|
|
User string `json:"user" binding:"required"`
|
|
Password string `json:"password" binding:"required"`
|
|
}
|
|
|
|
// Binding from form values
|
|
type LoginForm struct {
|
|
User string `form:"user" binding:"required"`
|
|
Password string `form:"password" binding:"required"`
|
|
}
|
|
|
|
func main() {
|
|
r := gin.Default()
|
|
|
|
// Example for binding JSON ({"user": "manu", "password": "123"})
|
|
r.POST("/loginJSON", func(c *gin.Context) {
|
|
var json LoginJSON
|
|
|
|
c.Bind(&json) // This will infer what binder to use depending on the content-type header.
|
|
if json.User == "manu" && json.Password == "123" {
|
|
c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
|
|
} else {
|
|
c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
|
|
}
|
|
})
|
|
|
|
// Example for binding a HTML form (user=manu&password=123)
|
|
r.POST("/loginHTML", func(c *gin.Context) {
|
|
var form LoginForm
|
|
|
|
c.BindWith(&form, binding.Form) // You can also specify which binder to use. We support binding.Form, binding.JSON and binding.XML.
|
|
if form.User == "manu" && form.Password == "123" {
|
|
c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
|
|
} else {
|
|
c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
|
|
}
|
|
})
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
r.Run(":8080")
|
|
}
|
|
```
|
|
|
|
|
|
###Multipart/Urlencoded binding
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/gin-gonic/gin/binding"
|
|
)
|
|
|
|
type LoginForm struct {
|
|
User string `form:"user" binding:"required"`
|
|
Password string `form:"password" binding:"required"`
|
|
}
|
|
|
|
func main() {
|
|
|
|
router := gin.Default()
|
|
|
|
router.POST("/login", func(c *gin.Context) {
|
|
// you can bind multipart form with explicit binding declaration:
|
|
// c.BindWith(&form, binding.Form)
|
|
// or you can simply use autobinding with Bind method:
|
|
var form LoginForm
|
|
c.Bind(&form) // in this case proper binding will be automatically selected
|
|
|
|
if form.User == "user" && form.Password == "password" {
|
|
c.JSON(200, gin.H{"status": "you are logged in"})
|
|
} else {
|
|
c.JSON(401, gin.H{"status": "unauthorized"})
|
|
}
|
|
})
|
|
|
|
router.Run(":8080")
|
|
|
|
}
|
|
```
|
|
|
|
Test it with:
|
|
```bash
|
|
$ curl -v --form user=user --form password=password http://localhost:8080/login
|
|
```
|
|
|
|
|
|
#### XML and JSON rendering
|
|
|
|
```go
|
|
func main() {
|
|
r := gin.Default()
|
|
|
|
// gin.H is a shortcut for map[string]interface{}
|
|
r.GET("/someJSON", func(c *gin.Context) {
|
|
c.JSON(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
|
|
})
|
|
|
|
r.GET("/moreJSON", func(c *gin.Context) {
|
|
// You also can use a struct
|
|
var msg struct {
|
|
Name string `json:"user"`
|
|
Message string
|
|
Number int
|
|
}
|
|
msg.Name = "Lena"
|
|
msg.Message = "hey"
|
|
msg.Number = 123
|
|
// Note that msg.Name becomes "user" in the JSON
|
|
// Will output : {"user": "Lena", "Message": "hey", "Number": 123}
|
|
c.JSON(http.StatusOK, msg)
|
|
})
|
|
|
|
r.GET("/someXML", func(c *gin.Context) {
|
|
c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
|
|
})
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
r.Run(":8080")
|
|
}
|
|
```
|
|
|
|
####Serving static files
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
router.Static("/assets", "./assets")
|
|
router.StaticFS("/more_static", http.Dir("my_file_system"))
|
|
router.StaticFile("/favicon.ico", "./resources/favicon.ico")
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
####HTML rendering
|
|
|
|
Using LoadHTMLTemplates()
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
router.LoadHTMLGlob("templates/*")
|
|
//router.LoadHTMLFiles("templates/template1.html", "templates/template2.html")
|
|
router.GET("/index", func(c *gin.Context) {
|
|
c.HTML(http.StatusOK, "index.tmpl", gin.H{
|
|
"title": "Main website",
|
|
})
|
|
})
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
```html
|
|
<html><h1>
|
|
{{ .title }}
|
|
</h1>
|
|
</html>
|
|
```
|
|
|
|
You can also use your own html template render
|
|
|
|
```go
|
|
import "html/template"
|
|
|
|
func main() {
|
|
router := gin.Default()
|
|
html := template.Must(template.ParseFiles("file1", "file2"))
|
|
router.SetHTMLTemplate(html)
|
|
router.Run(":8080")
|
|
}
|
|
```
|
|
|
|
|
|
#### Redirects
|
|
|
|
Issuing a HTTP redirect is easy:
|
|
|
|
```go
|
|
r.GET("/test", func(c *gin.Context) {
|
|
c.Redirect(http.StatusMovedPermanently, "http://www.google.com/")
|
|
})
|
|
```
|
|
Both internal and external locations are supported.
|
|
|
|
|
|
#### Custom Middlewares
|
|
|
|
```go
|
|
func Logger() gin.HandlerFunc {
|
|
return func(c *gin.Context) {
|
|
t := time.Now()
|
|
|
|
// Set example variable
|
|
c.Set("example", "12345")
|
|
|
|
// before request
|
|
|
|
c.Next()
|
|
|
|
// after request
|
|
latency := time.Since(t)
|
|
log.Print(latency)
|
|
|
|
// access the status we are sending
|
|
status := c.Writer.Status()
|
|
log.Println(status)
|
|
}
|
|
}
|
|
|
|
func main() {
|
|
r := gin.New()
|
|
r.Use(Logger())
|
|
|
|
r.GET("/test", func(c *gin.Context) {
|
|
example := c.MustGet("example").(string)
|
|
|
|
// it would print: "12345"
|
|
log.Println(example)
|
|
})
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
r.Run(":8080")
|
|
}
|
|
```
|
|
|
|
#### Using BasicAuth() middleware
|
|
```go
|
|
// simulate some private data
|
|
var secrets = gin.H{
|
|
"foo": gin.H{"email": "foo@bar.com", "phone": "123433"},
|
|
"austin": gin.H{"email": "austin@example.com", "phone": "666"},
|
|
"lena": gin.H{"email": "lena@guapa.com", "phone": "523443"},
|
|
}
|
|
|
|
func main() {
|
|
r := gin.Default()
|
|
|
|
// Group using gin.BasicAuth() middleware
|
|
// gin.Accounts is a shortcut for map[string]string
|
|
authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{
|
|
"foo": "bar",
|
|
"austin": "1234",
|
|
"lena": "hello2",
|
|
"manu": "4321",
|
|
}))
|
|
|
|
// /admin/secrets endpoint
|
|
// hit "localhost:8080/admin/secrets
|
|
authorized.GET("/secrets", func(c *gin.Context) {
|
|
// get user, it was setted by the BasicAuth middleware
|
|
user := c.MustGet(gin.AuthUserKey).(string)
|
|
if secret, ok := secrets[user]; ok {
|
|
c.JSON(http.StatusOK, gin.H{"user": user, "secret": secret})
|
|
} else {
|
|
c.JSON(http.StatusOK, gin.H{"user": user, "secret": "NO SECRET :("})
|
|
}
|
|
})
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
r.Run(":8080")
|
|
}
|
|
```
|
|
|
|
|
|
#### Goroutines inside a middleware
|
|
When starting inside a middleware or handler, you **SHOULD NOT** use the original context inside it, you have to use a read-only copy.
|
|
|
|
```go
|
|
func main() {
|
|
r := gin.Default()
|
|
|
|
r.GET("/long_async", func(c *gin.Context) {
|
|
// create copy to be used inside the goroutine
|
|
c_cp := c.Copy()
|
|
go func() {
|
|
// simulate a long task with time.Sleep(). 5 seconds
|
|
time.Sleep(5 * time.Second)
|
|
|
|
// note than you are using the copied context "c_cp", IMPORTANT
|
|
log.Println("Done! in path " + c_cp.Request.URL.Path)
|
|
}()
|
|
})
|
|
|
|
|
|
r.GET("/long_sync", func(c *gin.Context) {
|
|
// simulate a long task with time.Sleep(). 5 seconds
|
|
time.Sleep(5 * time.Second)
|
|
|
|
// since we are NOT using a goroutine, we do not have to copy the context
|
|
log.Println("Done! in path " + c.Request.URL.Path)
|
|
})
|
|
|
|
// Listen and server on 0.0.0.0:8080
|
|
r.Run(":8080")
|
|
}
|
|
```
|
|
|
|
#### Custom HTTP configuration
|
|
|
|
Use `http.ListenAndServe()` directly, like this:
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
http.ListenAndServe(":8080", router)
|
|
}
|
|
```
|
|
or
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
|
|
s := &http.Server{
|
|
Addr: ":8080",
|
|
Handler: router,
|
|
ReadTimeout: 10 * time.Second,
|
|
WriteTimeout: 10 * time.Second,
|
|
MaxHeaderBytes: 1 << 20,
|
|
}
|
|
s.ListenAndServe()
|
|
}
|
|
```
|