2014-07-02 16:36:23 +04:00
2015-07-11 18:53:54 +03:00
#Gin Web Framework
2016-01-27 05:37:24 +03:00
< img align = "right" src = "https://raw.githubusercontent.com/gin-gonic/gin/master/logo.jpg" >
2015-07-10 22:51:38 +03:00
[![Build Status ](https://travis-ci.org/gin-gonic/gin.svg )](https://travis-ci.org/gin-gonic/gin)
[![Coverage Status ](https://coveralls.io/repos/gin-gonic/gin/badge.svg?branch=master )](https://coveralls.io/r/gin-gonic/gin?branch=master)
2015-07-11 18:59:16 +03:00
[![GoDoc ](https://godoc.org/github.com/gin-gonic/gin?status.svg )](https://godoc.org/github.com/gin-gonic/gin)
[![Join the chat at https://gitter.im/gin-gonic/gin ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/gin-gonic/gin?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2015-02-21 14:24:57 +03:00
2016-01-30 03:34:20 +03:00
Gin is a web framework written in Go (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.
2014-09-13 22:37:27 +04:00
2015-07-11 18:53:54 +03:00
2015-02-04 15:18:37 +03:00
![Gin console logger ](https://gin-gonic.github.io/gin/other/console.png )
2014-07-02 22:52:47 +04:00
2015-08-17 13:49:28 +03:00
```sh
2014-09-13 22:37:27 +04:00
$ cat test.go
```
2015-07-03 21:12:01 +03:00
```go
2014-09-13 22:37:27 +04:00
package main
2015-05-31 06:00:47 +03:00
import "github.com/gin-gonic/gin"
2014-09-13 22:37:27 +04:00
func main() {
2015-05-31 06:00:47 +03:00
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
2016-01-30 03:28:57 +03:00
c.JSON(200, gin.H{
2016-01-30 03:32:46 +03:00
"message": "pong",
2016-01-30 03:28:57 +03:00
})
2014-09-13 22:37:27 +04:00
})
2016-01-30 03:28:57 +03:00
r.Run() // listen and server on 0.0.0.0:8080
2014-09-13 22:37:27 +04:00
}
```
2015-06-01 02:39:08 +03:00
## Benchmarks
2015-06-04 03:49:14 +03:00
Gin uses a custom version of [HttpRouter ](https://github.com/julienschmidt/httprouter )
[See all benchmarks ](/BENCHMARKS.md )
2015-07-11 12:30:03 +03:00
Benchmark name | (1) | (2) | (3) | (4)
--------------------------------|----------:|----------:|----------:|------:
BenchmarkAce_GithubAll | 10000 | 109482 | 13792 | 167
BenchmarkBear_GithubAll | 10000 | 287490 | 79952 | 943
BenchmarkBeego_GithubAll | 3000 | 562184 | 146272 | 2092
BenchmarkBone_GithubAll | 500 | 2578716 | 648016 | 8119
BenchmarkDenco_GithubAll | 20000 | 94955 | 20224 | 167
BenchmarkEcho_GithubAll | 30000 | 58705 | 0 | 0
**BenchmarkGin_GithubAll** | **30000** | **50991** | **0** | **0**
BenchmarkGocraftWeb_GithubAll | 5000 | 449648 | 133280 | 1889
BenchmarkGoji_GithubAll | 2000 | 689748 | 56113 | 334
BenchmarkGoJsonRest_GithubAll | 5000 | 537769 | 135995 | 2940
BenchmarkGoRestful_GithubAll | 100 | 18410628 | 797236 | 7725
BenchmarkGorillaMux_GithubAll | 200 | 8036360 | 153137 | 1791
BenchmarkHttpRouter_GithubAll | 20000 | 63506 | 13792 | 167
BenchmarkHttpTreeMux_GithubAll | 10000 | 165927 | 56112 | 334
BenchmarkKocha_GithubAll | 10000 | 171362 | 23304 | 843
BenchmarkMacaron_GithubAll | 2000 | 817008 | 224960 | 2315
BenchmarkMartini_GithubAll | 100 | 12609209 | 237952 | 2686
BenchmarkPat_GithubAll | 300 | 4830398 | 1504101 | 32222
BenchmarkPossum_GithubAll | 10000 | 301716 | 97440 | 812
BenchmarkR2router_GithubAll | 10000 | 270691 | 77328 | 1182
BenchmarkRevel_GithubAll | 1000 | 1491919 | 345553 | 5918
BenchmarkRivet_GithubAll | 10000 | 283860 | 84272 | 1079
BenchmarkTango_GithubAll | 5000 | 473821 | 87078 | 2470
BenchmarkTigerTonic_GithubAll | 2000 | 1120131 | 241088 | 6052
BenchmarkTraffic_GithubAll | 200 | 8708979 | 2664762 | 22390
BenchmarkVulcan_GithubAll | 5000 | 353392 | 19894 | 609
BenchmarkZeus_GithubAll | 2000 | 944234 | 300688 | 2648
2015-06-01 02:39:08 +03:00
2015-07-11 12:30:03 +03:00
(1): Total Repetitions
(2): Single Repetition Duration (ns/op)
(3): Heap Memory (B/op)
(4): Average Allocations per Repetition (allocs/op)
2015-06-01 02:39:08 +03:00
##Gin v1. stable
2015-05-31 06:00:47 +03:00
- [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.
2014-07-02 22:52:47 +04:00
2014-06-18 03:42:34 +04:00
## Start using it
2015-05-31 06:00:47 +03:00
1. Download and install it:
2014-06-18 03:42:34 +04:00
2016-02-24 17:02:40 +03:00
```sh
$ go get github.com/gin-gonic/gin
```
2015-05-31 06:00:47 +03:00
2. Import it in your code:
2014-06-18 03:42:34 +04:00
2016-02-24 17:02:40 +03:00
```go
import "github.com/gin-gonic/gin"
```
2016-02-24 21:02:39 +03:00
3. (Optional) Import `net/http` . This is required for example if using constants such as `http.StatusOK` .
2016-02-24 17:02:40 +03:00
```go
import "net/http"
```
2014-06-18 03:42:34 +04:00
##API Examples
2014-07-03 18:16:40 +04:00
#### Using GET, POST, PUT, PATCH, DELETE and OPTIONS
2014-06-30 05:58:10 +04:00
```go
func main() {
2015-07-03 21:12:01 +03:00
// Creates a gin router with default middleware:
// logger and recovery (crash-free) middleware
2015-05-31 06:00:47 +03:00
router := gin.Default()
2014-06-18 03:42:34 +04:00
2015-05-31 06:00:47 +03:00
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)
2014-07-04 21:44:07 +04:00
2016-01-30 03:28:57 +03:00
// By default it serves on :8080 unless a
// PORT environment variable was defined.
router.Run()
2016-02-18 04:45:37 +03:00
// router.Run(":3000") for a hard coded port
2014-06-18 03:42:34 +04:00
}
```
#### Parameters in path
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2015-05-31 06:00:47 +03:00
router := gin.Default()
2015-07-03 21:12:01 +03:00
2014-07-08 13:55:20 +04:00
// This handler will match /user/john but will not match neither /user/ or /user
2015-05-31 06:00:47 +03:00
router.GET("/user/:name", func(c *gin.Context) {
name := c.Param("name")
c.String(http.StatusOK, "Hello %s", name)
2014-07-04 23:37:33 +04:00
})
2015-01-31 15:09:44 +03:00
// However, this one will match /user/john/ and also /user/john/send
2016-01-14 23:58:17 +03:00
// If no other routers match /user/john, it will redirect to /user/john/
2015-05-31 06:00:47 +03:00
router.GET("/user/:name/*action", func(c *gin.Context) {
name := c.Param("name")
action := c.Param("action")
2014-07-04 23:37:33 +04:00
message := name + " is " + action
2015-03-05 09:14:01 +03:00
c.String(http.StatusOK, message)
2014-07-04 21:44:07 +04:00
})
2015-07-03 21:12:01 +03:00
2015-05-31 06:00:47 +03:00
router.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
2015-05-26 07:15:52 +03:00
#### Querystring parameters
```go
func main() {
2015-08-17 13:49:28 +03:00
router := gin.Default()
2015-05-26 18:11:20 +03:00
2015-08-17 13:49:28 +03:00
// 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")
2015-05-26 18:11:20 +03:00
2015-08-17 13:49:28 +03:00
c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
})
router.Run(":8080")
2015-05-26 07:15:52 +03:00
}
```
2015-07-03 21:12:01 +03:00
### Multipart/Urlencoded Form
2014-06-18 03:42:34 +04:00
2015-03-08 17:50:23 +03:00
```go
func main() {
2015-08-17 13:49:28 +03:00
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,
"nick": nick,
})
})
router.Run(":8080")
2015-03-08 17:50:23 +03:00
}
```
2015-07-05 04:26:30 +03:00
### Another example: query + post form
```
POST /post?id=1234& page=1 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
name=manu& message=this_is_great
```
```go
func main() {
router := gin.Default()
router.POST("/post", func(c *gin.Context) {
2015-08-17 13:49:28 +03:00
id := c.Query("id")
page := c.DefaultQuery("page", "0")
name := c.PostForm("name")
message := c.PostForm("message")
2015-07-05 04:26:30 +03:00
2015-08-17 13:49:28 +03:00
fmt.Printf("id: %s; page: %s; name: %s; message: %s", id, page, name, message)
2015-07-05 04:26:30 +03:00
})
router.Run(":8080")
}
```
```
2015-08-17 13:27:38 +03:00
id: 1234; page: 1; name: manu; message: this_is_great
2015-07-05 04:26:30 +03:00
```
2014-06-18 03:42:34 +04:00
#### Grouping routes
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2015-05-31 06:00:47 +03:00
router := gin.Default()
2014-06-18 03:42:34 +04:00
2014-07-04 21:44:07 +04:00
// Simple group: v1
2015-05-31 06:00:47 +03:00
v1 := router.Group("/v1")
2014-07-04 21:44:07 +04:00
{
v1.POST("/login", loginEndpoint)
v1.POST("/submit", submitEndpoint)
v1.POST("/read", readEndpoint)
}
// Simple group: v2
2015-05-31 06:00:47 +03:00
v2 := router.Group("/v2")
2014-07-04 21:44:07 +04:00
{
v2.POST("/login", loginEndpoint)
v2.POST("/submit", submitEndpoint)
v2.POST("/read", readEndpoint)
}
2015-05-31 06:00:47 +03:00
router.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
2015-07-03 21:12:01 +03:00
#### Blank Gin without middleware by default
2014-06-18 03:42:34 +04:00
Use
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
r := gin.New()
```
instead of
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
r := gin.Default()
```
2015-07-03 21:12:01 +03:00
#### Using middleware
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2014-07-04 21:44:07 +04:00
// Creates a router without any middleware by default
r := gin.New()
2015-07-03 21:12:01 +03:00
// Global middleware
2014-07-04 21:44:07 +04:00
r.Use(gin.Logger())
r.Use(gin.Recovery())
2015-07-03 21:12:01 +03:00
// Per route middleware, you can add as many as you desire.
2014-07-04 21:44:07 +04:00
r.GET("/benchmark", MyBenchLogger(), benchEndpoint)
// Authorization group
// authorized := r.Group("/", AuthRequired())
// exactly the same than:
authorized := r.Group("/")
2015-07-03 21:12:01 +03:00
// per group middleware! in this case we use the custom created
2014-07-04 21:44:07 +04:00
// 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")
2014-06-18 03:42:34 +04:00
}
```
2014-08-03 03:31:48 +04:00
#### Model binding and validation
2014-06-18 03:42:34 +04:00
2014-08-03 03:31:48 +04:00
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"` .
2015-07-03 21:12:01 +03:00
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.
2014-08-03 03:31:48 +04:00
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.
2014-06-18 03:42:34 +04:00
2014-06-30 05:58:10 +04:00
```go
2014-08-03 03:31:48 +04:00
// Binding from JSON
2015-07-05 04:26:30 +03:00
type Login struct {
User string `form:"user" json:"user" binding:"required"`
Password string `form:"password" json:"password" binding:"required"`
2014-08-03 03:31:48 +04:00
}
2014-06-18 03:42:34 +04:00
func main() {
2015-07-05 04:26:30 +03:00
router := gin.Default()
2014-07-02 10:24:55 +04:00
2015-08-17 13:49:28 +03:00
// Example for binding JSON ({"user": "manu", "password": "123"})
2015-07-05 04:26:30 +03:00
router.POST("/loginJSON", func(c *gin.Context) {
var json Login
2015-08-17 13:49:28 +03:00
if c.BindJSON(& json) == nil {
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"})
}
}
2014-07-04 21:44:07 +04:00
})
2015-08-17 13:49:28 +03:00
// Example for binding a HTML form (user=manu& password=123)
router.POST("/loginForm", func(c *gin.Context) {
var form Login
// This will infer what binder to use depending on the content-type header.
if c.Bind(& form) == nil {
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"})
}
}
})
2014-08-03 03:31:48 +04:00
2014-07-04 21:44:07 +04:00
// Listen and server on 0.0.0.0:8080
2015-07-05 04:26:30 +03:00
router.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
2015-05-31 06:00:47 +03:00
2015-07-03 21:12:01 +03:00
###Multipart/Urlencoded binding
2015-05-31 06:00:47 +03:00
```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
2015-08-17 13:49:28 +03:00
// in this case proper binding will be automatically selected
2015-07-05 04:26:30 +03:00
if c.Bind(& form) == nil {
2015-08-17 13:49:28 +03:00
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"})
}
}
2015-05-31 06:00:47 +03:00
})
router.Run(":8080")
}
```
Test it with:
2015-08-17 13:49:28 +03:00
```sh
2015-05-31 06:00:47 +03:00
$ curl -v --form user=user --form password=password http://localhost:8080/login
```
2014-07-29 02:48:02 +04:00
#### XML and JSON rendering
2014-06-18 03:42:34 +04:00
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2014-07-04 21:44:07 +04:00
r := gin.Default()
2014-07-02 10:24:55 +04:00
2014-12-02 17:39:24 +03:00
// gin.H is a shortcut for map[string]interface{}
2014-07-04 21:44:07 +04:00
r.GET("/someJSON", func(c *gin.Context) {
2015-03-05 09:14:01 +03:00
c.JSON(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
2014-07-04 21:44:07 +04:00
})
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}
2015-03-05 09:14:01 +03:00
c.JSON(http.StatusOK, msg)
2014-07-04 21:44:07 +04:00
})
r.GET("/someXML", func(c *gin.Context) {
2015-03-05 09:14:01 +03:00
c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
2014-07-04 21:44:07 +04:00
})
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
2015-02-04 14:37:22 +03:00
####Serving static files
```go
func main() {
2015-08-17 13:49:28 +03:00
router := gin.Default()
router.Static("/assets", "./assets")
router.StaticFS("/more_static", http.Dir("my_file_system"))
router.StaticFile("/favicon.ico", "./resources/favicon.ico")
2015-02-04 14:37:22 +03:00
2015-08-17 13:49:28 +03:00
// Listen and server on 0.0.0.0:8080
router.Run(":8080")
2015-02-04 14:37:22 +03:00
}
```
2014-06-18 03:42:34 +04:00
####HTML rendering
Using LoadHTMLTemplates()
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2015-05-31 06:00:47 +03:00
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",
})
2014-07-04 21:44:07 +04:00
})
2015-05-31 06:00:47 +03:00
router.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
2015-06-02 18:06:08 +03:00
templates/index.tmpl
2015-01-05 18:15:42 +03:00
```html
2015-08-17 13:49:28 +03:00
< html >
< h1 >
{{ .title }}
< / h1 >
2015-05-31 06:00:47 +03:00
< / html >
2015-01-05 18:15:42 +03:00
```
2014-06-18 03:42:34 +04:00
2015-06-02 18:06:08 +03:00
Using templates with same name in different directories
```go
func main() {
router := gin.Default()
router.LoadHTMLGlob("templates/**/*")
2015-06-02 18:12:00 +03:00
router.GET("/posts/index", func(c *gin.Context) {
c.HTML(http.StatusOK, "posts/index.tmpl", gin.H{
2015-06-02 18:06:08 +03:00
"title": "Posts",
})
})
2015-06-02 18:12:00 +03:00
router.GET("/users/index", func(c *gin.Context) {
c.HTML(http.StatusOK, "users/index.tmpl", gin.H{
2015-06-02 18:06:08 +03:00
"title": "Users",
})
})
router.Run(":8080")
}
```
2015-06-02 18:12:00 +03:00
templates/posts/index.tmpl
2015-06-02 18:06:08 +03:00
```html
2015-06-02 18:12:00 +03:00
{{ define "posts/index.tmpl" }}
2015-06-02 18:06:08 +03:00
< html > < h1 >
{{ .title }}
< / h1 >
2015-06-02 18:12:00 +03:00
< p > Using posts/index.tmpl< / p >
2015-06-02 18:06:08 +03:00
< / html >
{{ end }}
```
2015-06-02 18:12:00 +03:00
templates/users/index.tmpl
2015-06-02 18:06:08 +03:00
```html
2015-06-02 18:12:00 +03:00
{{ define "users/index.tmpl" }}
2015-06-02 18:06:08 +03:00
< html > < h1 >
{{ .title }}
< / h1 >
2015-06-02 18:12:00 +03:00
< p > Using users/index.tmpl< / p >
2015-06-02 18:06:08 +03:00
< / html >
{{ end }}
```
2014-06-18 03:42:34 +04:00
You can also use your own html template render
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
import "html/template"
2014-07-04 21:44:07 +04:00
2014-06-18 03:42:34 +04:00
func main() {
2015-05-31 06:00:47 +03:00
router := gin.Default()
2014-07-04 21:44:07 +04:00
html := template.Must(template.ParseFiles("file1", "file2"))
2015-05-31 06:00:47 +03:00
router.SetHTMLTemplate(html)
router.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
2015-03-08 19:24:23 +03:00
2014-07-29 02:48:02 +04:00
#### Redirects
Issuing a HTTP redirect is easy:
2014-08-21 17:32:32 +04:00
```go
r.GET("/test", func(c *gin.Context) {
2015-03-05 09:14:01 +03:00
c.Redirect(http.StatusMovedPermanently, "http://www.google.com/")
2014-07-29 02:48:02 +04:00
})
```
2014-08-21 17:32:32 +04:00
Both internal and external locations are supported.
2014-06-18 03:42:34 +04:00
2015-07-03 21:12:01 +03:00
#### Custom Middleware
2014-06-18 03:42:34 +04:00
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func Logger() gin.HandlerFunc {
2014-07-04 21:44:07 +04:00
return func(c *gin.Context) {
t := time.Now()
2014-07-04 02:16:41 +04:00
2014-07-04 21:44:07 +04:00
// Set example variable
c.Set("example", "12345")
2014-07-04 02:16:41 +04:00
2014-07-04 21:44:07 +04:00
// before request
2014-07-04 02:16:41 +04:00
2014-07-04 21:44:07 +04:00
c.Next()
2014-07-04 02:16:41 +04:00
2014-07-04 21:44:07 +04:00
// after request
latency := time.Since(t)
log.Print(latency)
2014-07-04 02:01:28 +04:00
2014-07-04 23:37:33 +04:00
// access the status we are sending
status := c.Writer.Status()
log.Println(status)
2014-07-04 21:44:07 +04:00
}
2014-06-18 03:42:34 +04:00
}
func main() {
2014-07-04 21:44:07 +04:00
r := gin.New()
r.Use(Logger())
2014-07-02 10:24:55 +04:00
2014-07-04 21:44:07 +04:00
r.GET("/test", func(c *gin.Context) {
2014-07-08 03:32:41 +04:00
example := c.MustGet("example").(string)
2014-07-04 02:16:41 +04:00
2014-07-04 21:44:07 +04:00
// it would print: "12345"
log.Println(example)
})
2014-07-02 10:24:55 +04:00
2014-07-04 21:44:07 +04:00
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
2014-06-30 05:58:10 +04:00
}
2014-06-18 03:42:34 +04:00
```
2014-07-04 06:30:30 +04:00
#### Using BasicAuth() middleware
```go
2015-02-12 09:29:11 +03:00
// simulate some private data
2014-07-04 06:47:34 +04:00
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"},
}
2014-07-04 06:30:30 +04:00
func main() {
2014-07-04 06:47:34 +04:00
r := gin.Default()
2014-07-04 06:30:30 +04:00
2014-07-04 06:47:34 +04:00
// Group using gin.BasicAuth() middleware
// gin.Accounts is a shortcut for map[string]string
2014-07-04 06:30:30 +04:00
authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{
2014-07-04 06:47:34 +04:00
"foo": "bar",
2014-07-04 06:30:30 +04:00
"austin": "1234",
2014-07-04 06:47:34 +04:00
"lena": "hello2",
"manu": "4321",
}))
// /admin/secrets endpoint
// hit "localhost:8080/admin/secrets
2014-07-04 06:30:30 +04:00
authorized.GET("/secrets", func(c *gin.Context) {
2016-03-05 01:27:19 +03:00
// get user, it was set by the BasicAuth middleware
2015-01-01 19:06:02 +03:00
user := c.MustGet(gin.AuthUserKey).(string)
2014-07-04 06:30:30 +04:00
if secret, ok := secrets[user]; ok {
2015-03-05 09:14:01 +03:00
c.JSON(http.StatusOK, gin.H{"user": user, "secret": secret})
2014-07-04 06:30:30 +04:00
} else {
2015-03-05 09:14:01 +03:00
c.JSON(http.StatusOK, gin.H{"user": user, "secret": "NO SECRET :("})
2014-07-04 06:30:30 +04:00
}
2014-07-04 06:47:34 +04:00
})
2014-07-04 06:30:30 +04:00
2014-07-04 06:47:34 +04:00
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
2014-06-30 05:58:10 +04:00
}
2014-06-18 03:42:34 +04:00
```
2014-07-04 06:30:30 +04:00
#### 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.
2014-06-18 03:42:34 +04:00
2014-07-04 06:30:30 +04:00
```go
func main() {
r := gin.Default()
r.GET("/long_async", func(c *gin.Context) {
// create copy to be used inside the goroutine
2015-08-17 13:49:28 +03:00
cCp := c.Copy()
2014-07-04 06:30:30 +04:00
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
2015-08-17 13:49:28 +03:00
log.Println("Done! in path " + cCp.Request.URL.Path)
2014-07-04 06:30:30 +04:00
}()
})
2014-06-18 03:42:34 +04:00
2014-07-04 06:30:30 +04:00
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
2014-08-19 12:38:03 +04:00
log.Println("Done! in path " + c.Request.URL.Path)
2014-07-04 06:30:30 +04:00
})
2015-08-17 13:49:28 +03:00
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
2014-07-04 06:30:30 +04:00
}
```
2014-06-18 03:42:34 +04:00
#### Custom HTTP configuration
2014-06-30 05:58:10 +04:00
Use `http.ListenAndServe()` directly, like this:
2014-06-18 03:42:34 +04:00
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2014-07-04 21:44:07 +04:00
router := gin.Default()
http.ListenAndServe(":8080", router)
2014-06-18 03:42:34 +04:00
}
```
or
2014-06-30 05:58:10 +04:00
```go
2014-06-18 03:42:34 +04:00
func main() {
2014-07-04 21:44:07 +04:00
router := gin.Default()
s := & http.Server{
Addr: ":8080",
Handler: router,
ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second,
MaxHeaderBytes: 1 < < 20 ,
}
s.ListenAndServe()
2014-06-18 03:42:34 +04:00
}
2014-07-01 00:57:25 +04:00
```
2015-11-11 05:27:36 +03:00
#### Graceful restart or stop
Do you want to graceful restart or stop your web server?
There be some ways.
We can using fvbock/endless to replace the default ListenAndServe
2016-01-27 05:37:24 +03:00
Refer the issue for more details:
2015-11-11 05:27:36 +03:00
https://github.com/gin-gonic/gin/issues/296
```go
router := gin.Default()
router.GET("/", handler)
// [...]
endless.ListenAndServe(":4242", router)
```
2016-03-14 04:11:59 +03:00
An alternative to endless:
* [manners ](https://github.com/braintree/manners ): A polite Go HTTP server that shuts down gracefully.