gin/README.md

770 lines
19 KiB
Markdown
Raw Normal View History

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)
[![codecov](https://codecov.io/gh/gin-gonic/gin/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-gonic/gin)
2016-04-15 02:16:46 +03:00
[![Go Report Card](https://goreportcard.com/badge/github.com/gin-gonic/gin)](https://goreportcard.com/report/github.com/gin-gonic/gin)
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
![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
```
```go
2014-09-13 22:37:27 +04:00
package main
import "gopkg.in/gin-gonic/gin.v1"
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-10-28 17:02:10 +03:00
r.Run() // listen and serve 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)
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
(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
2016-04-15 04:17:38 +03:00
## Gin v1. stable
2015-06-01 02:39:08 +03:00
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
2016-04-15 04:17:38 +03:00
2015-05-31 06:00:47 +03:00
1. Download and install it:
2014-06-18 03:42:34 +04:00
```sh
$ go get gopkg.in/gin-gonic/gin.v1
```
2015-05-31 06:00:47 +03:00
2. Import it in your code:
2014-06-18 03:42:34 +04:00
```go
import "gopkg.in/gin-gonic/gin.v1"
```
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`.
```go
import "net/http"
```
2014-06-18 03:42:34 +04:00
2016-04-15 04:17:38 +03:00
## API Examples
2014-06-18 03:42:34 +04:00
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() {
// Disable Console Color
// gin.DisableConsoleColor()
// 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()
// 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)
})
// 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")
message := name + " is " + action
c.String(http.StatusOK, message)
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
}
```
#### 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")
}
```
### 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
```
2016-03-14 05:07:55 +03:00
### Another example: upload file
2016-04-01 10:57:00 +03:00
References issue [#548](https://github.com/gin-gonic/gin/issues/548).
2016-03-14 05:07:55 +03:00
```go
func main() {
router := gin.Default()
router.POST("/upload", func(c *gin.Context) {
file, header , err := c.Request.FormFile("upload")
filename := header.Filename
fmt.Println(header.Filename)
out, err := os.Create("./tmp/"+filename+".png")
if err != nil {
log.Fatal(err)
}
defer out.Close()
_, err = io.Copy(out, file)
if err != nil {
log.Fatal(err)
}
})
router.Run(":8080")
}
```
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
}
```
#### 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()
```
#### 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()
// Global middleware
2014-07-04 21:44:07 +04:00
r.Use(gin.Logger())
r.Use(gin.Recovery())
// 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())
2016-04-01 10:57:00 +03:00
// exactly the same as:
2014-07-04 21:44:07 +04:00
authorized := r.Group("/")
// 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)
}
2016-10-28 17:02:10 +03:00
// Listen and serve on 0.0.0.0:8080
2014-07-04 21:44:07 +04:00
r.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
#### Model binding and validation
2014-06-18 03:42:34 +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"`.
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.
2014-06-18 03:42:34 +04:00
2014-06-30 05:58:10 +04:00
```go
// 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-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"})
}
}
})
2016-10-28 17:02:10 +03:00
// Listen and serve 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
}
```
#### Bind Query String
See the [detail information](https://github.com/gin-gonic/gin/issues/742#issuecomment-264681292).
```go
package main
import "log"
import "github.com/gin-gonic/gin"
type Person struct {
Name string `form:"name"`
Address string `form:"address"`
}
func main() {
route := gin.Default()
route.GET("/testing", startPage)
route.Run(":8085")
}
func startPage(c *gin.Context) {
var person Person
if c.Bind(&person) == nil {
log.Println(person.Name)
log.Println(person.Address)
}
c.String(200, "Success")
}
```
### Multipart/Urlencoded binding
2015-05-31 06:00:47 +03:00
```go
package main
import (
"gopkg.in/gin-gonic/gin.v1"
2015-05-31 06:00:47 +03:00
)
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
```
2016-04-15 10:23:47 +03:00
#### XML, JSON and YAML 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) {
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}
c.JSON(http.StatusOK, msg)
2014-07-04 21:44:07 +04:00
})
r.GET("/someXML", func(c *gin.Context) {
c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
2014-07-04 21:44:07 +04:00
})
2016-04-15 10:23:47 +03:00
r.GET("/someYAML", func(c *gin.Context) {
c.YAML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
})
2016-10-28 17:02:10 +03:00
// Listen and serve on 0.0.0.0:8080
2014-07-04 21:44:07 +04:00
r.Run(":8080")
2014-06-18 03:42:34 +04: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")
2016-10-28 17:02:10 +03:00
// Listen and serve on 0.0.0.0:8080
2015-08-17 13:49:28 +03:00
router.Run(":8080")
}
```
2014-06-18 03:42:34 +04:00
####HTML rendering
2016-06-08 01:37:09 +03:00
Using LoadHTMLGlob() or LoadHTMLFiles()
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() {
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
}
```
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
Using templates with same name in different directories
```go
func main() {
router := gin.Default()
router.LoadHTMLGlob("templates/**/*")
router.GET("/posts/index", func(c *gin.Context) {
c.HTML(http.StatusOK, "posts/index.tmpl", gin.H{
"title": "Posts",
})
})
router.GET("/users/index", func(c *gin.Context) {
c.HTML(http.StatusOK, "users/index.tmpl", gin.H{
"title": "Users",
})
})
router.Run(":8080")
}
```
templates/posts/index.tmpl
```html
{{ define "posts/index.tmpl" }}
<html><h1>
{{ .title }}
</h1>
<p>Using posts/index.tmpl</p>
</html>
{{ end }}
```
templates/users/index.tmpl
```html
{{ define "users/index.tmpl" }}
<html><h1>
{{ .title }}
</h1>
<p>Using users/index.tmpl</p>
</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
}
```
2014-07-29 02:48:02 +04:00
#### Redirects
Issuing a HTTP redirect is easy:
```go
r.GET("/test", func(c *gin.Context) {
c.Redirect(http.StatusMovedPermanently, "http://www.google.com/")
2014-07-29 02:48:02 +04:00
})
```
Both internal and external locations are supported.
2014-06-18 03:42:34 +04: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 21:44:07 +04:00
// Set example variable
c.Set("example", "12345")
2014-07-04 21:44:07 +04:00
// before request
2014-07-04 21:44:07 +04:00
c.Next()
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
// 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) {
example := c.MustGet("example").(string)
2014-07-04 21:44:07 +04:00
// it would print: "12345"
log.Println(example)
})
2014-07-02 10:24:55 +04:00
2016-10-28 17:02:10 +03:00
// Listen and serve on 0.0.0.0:8080
2014-07-04 21:44:07 +04:00
r.Run(":8080")
2014-06-30 05:58:10 +04:00
}
2014-06-18 03:42:34 +04:00
```
#### Using BasicAuth() middleware
```go
// 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"},
}
func main() {
2014-07-04 06:47:34 +04:00
r := gin.Default()
2014-07-04 06:47:34 +04:00
// Group using gin.BasicAuth() middleware
// gin.Accounts is a shortcut for map[string]string
authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{
2014-07-04 06:47:34 +04:00
"foo": "bar",
"austin": "1234",
2014-07-04 06:47:34 +04:00
"lena": "hello2",
"manu": "4321",
}))
// /admin/secrets endpoint
// hit "localhost:8080/admin/secrets
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)
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 :("})
}
2014-07-04 06:47:34 +04:00
})
2016-10-28 17:02:10 +03:00
// Listen and serve on 0.0.0.0:8080
2014-07-04 06:47:34 +04:00
r.Run(":8080")
2014-06-30 05:58:10 +04:00
}
2014-06-18 03:42:34 +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
```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()
go func() {
// simulate a long task with time.Sleep(). 5 seconds
time.Sleep(5 * time.Second)
2016-04-01 10:57:00 +03:00
// note that you are using the copied context "cCp", IMPORTANT
2015-08-17 13:49:28 +03:00
log.Println("Done! in path " + cCp.Request.URL.Path)
}()
})
2014-06-18 03:42:34 +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)
})
2016-10-28 17:02:10 +03:00
// Listen and serve on 0.0.0.0:8080
2015-08-17 13:49:28 +03:00
r.Run(":8080")
}
```
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
```
#### Graceful restart or stop
Do you want to graceful restart or stop your web server?
2016-04-01 10:57:00 +03:00
There are some ways this can be done.
2016-04-01 10:57:00 +03:00
We can use [fvbock/endless](https://github.com/fvbock/endless) to replace the default `ListenAndServe`. Refer issue [#296](https://github.com/gin-gonic/gin/issues/296) for more details.
```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.
2016-04-15 04:17:38 +03:00
## Contributing
- With issues:
- Use the search tool before opening a new issue.
- Please provide source code and commit sha if you found a bug.
- Review existing issues and provide feedback or react to them.
- With pull requests:
- Open your pull request against develop
- Your pull request should have no more than two commits, if not you should squash them.
- It should pass all tests in the available continuous integrations systems such as TravisCI.
- You should add/modify tests to cover your proposed code changes.
- If your pull request contains a new feature, please document it on the README.
2016-04-15 04:17:38 +03:00
## Example
Awesome project lists using [Gin](https://github.com/gin-gonic/gin) web framework.
* [drone](https://github.com/drone/drone): Drone is a Continuous Delivery platform built on Docker, written in Go
* [gorush](https://github.com/appleboy/gorush): A push notification server written in Go.