2015-02-07 17:04:24 +03:00
#Gin Web Framework [![GoDoc](https://godoc.org/github.com/gin-gonic/gin?status.svg)](https://godoc.org/github.com/gin-gonic/gin) [![Build Status](https://travis-ci.org/gin-gonic/gin.svg)](https://travis-ci.org/gin-gonic/gin)
2014-07-02 16:36:23 +04:00
2014-11-02 14:23:31 +03:00
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.
2014-09-13 22:37:27 +04: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
2014-09-13 22:37:27 +04:00
```
$ cat test.go
```
```go
package main
import "github.com/gin-gonic/gin"
func main() {
router := gin.Default()
router.GET("/", func(c *gin.Context) {
c.String(200, "hello world")
})
router.GET("/ping", func(c *gin.Context) {
c.String(200, "pong")
})
router.POST("/submit", func(c *gin.Context) {
c.String(401, "not authorized")
})
router.PUT("/error", func(c *gin.Context) {
c.String(500, "and error hapenned :(")
})
router.Run(":8080")
}
```
2014-07-02 22:52:47 +04:00
##Gin is new, will it be supported?
2015-02-05 01:00:51 +03:00
Yes, Gin is an internal tool of [Manu ](https://github.com/manucorporat ) and [Javi ](https://github.com/javierprovecho ) for many of our projects/start-ups. We developed it and we are going to continue using and improve it.
2014-07-02 22:52:47 +04:00
2014-07-18 17:22:38 +04:00
##Roadmap for v1.0
2014-07-05 21:27:33 +04:00
- [ ] Ask our designer for a cool logo
2014-07-06 20:57:58 +04:00
- [ ] Add tons of unit tests
- [ ] Add internal benchmarks suite
2015-02-05 01:00:51 +03:00
- [ ] More powerful validation API
- [ ] Improve documentation
- [ ] Add Swagger support
- [x] Stable API
2014-07-05 21:27:33 +04:00
- [x] Improve logging system
- [x] Improve JSON/XML validation using bindings
2014-07-06 20:57:58 +04:00
- [x] Improve XML support
2014-07-18 17:22:38 +04:00
- [x] Flexible rendering system
2015-02-05 01:00:51 +03:00
- [x] Add more cool middlewares, for example redis caching (this also helps developers to understand the framework).
2014-07-05 21:28:45 +04:00
- [x] Continuous integration
2015-02-05 01:00:51 +03:00
- [x] Performance improments, reduce allocation and garbage collection overhead
- [x] Fix bugs
2014-07-02 22:52:47 +04:00
2014-06-18 03:42:34 +04:00
## Start using it
2014-09-03 19:42:49 +04:00
Obviously, you need to have Git and Go already installed to run Gin.
2014-07-04 06:30:30 +04:00
Run this in your terminal
2014-06-18 03:42:34 +04:00
```
go get github.com/gin-gonic/gin
```
2014-09-03 19:42:49 +04:00
Then import it in your Go code:
2014-06-18 03:42:34 +04:00
```
import "github.com/gin-gonic/gin"
```
2014-07-16 21:00:47 +04:00
##Community
If you'd like to help out with the project, there's a mailing list and IRC channel where Gin discussions normally happen.
* IRC
* [irc.freenode.net #getgin ](irc://irc.freenode.net:6667/getgin )
* [Webchat ](http://webchat.freenode.net?randomnick=1&channels=%23getgin )
* Mailing List
* Subscribe: [getgin@librelist.org ](mailto:getgin@librelist.org )
* [Archives ](http://librelist.com/browser/getgin/ )
2014-06-18 03:42:34 +04:00
##API Examples
#### Create most basic PING/PONG HTTP endpoint
2014-06-30 05:58:10 +04:00
```go
2014-07-04 21:44:07 +04:00
package main
2014-06-30 05:58:10 +04:00
import "github.com/gin-gonic/gin"
2014-06-18 03:42:34 +04:00
func main() {
2014-07-04 21:44:07 +04:00
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.String(200, "pong")
})
2015-02-08 23:43:41 +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-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() {
2014-07-04 21:44:07 +04:00
// Creates a gin router + logger and recovery (crash-free) middlewares
r := gin.Default()
2014-06-18 03:42:34 +04:00
2014-07-04 21:44:07 +04:00
r.GET("/someGet", getting)
r.POST("/somePost", posting)
r.PUT("/somePut", putting)
r.DELETE("/someDelete", deleting)
r.PATCH("/somePatch", patching)
2014-07-04 23:37:33 +04:00
r.HEAD("/someHead", head)
r.OPTIONS("/someOptions", options)
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
}
```
#### Parameters in path
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-08 13:55:20 +04:00
// This handler will match /user/john but will not match neither /user/ or /user
2014-07-04 21:44:07 +04:00
r.GET("/user/:name", func(c *gin.Context) {
name := c.Params.ByName("name")
2014-07-04 23:37:33 +04:00
message := "Hello "+name
c.String(200, message)
})
2015-01-31 15:09:44 +03:00
// 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/
2014-07-08 13:55:20 +04:00
r.GET("/user/:name/*action", func(c *gin.Context) {
2014-07-04 23:37:33 +04:00
name := c.Params.ByName("name")
action := c.Params.ByName("action")
message := name + " is " + action
2014-07-04 21:44:07 +04:00
c.String(200, message)
})
2014-07-08 13:55:20 +04:00
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-06 20:14:12 +03:00
###Form parameters
```go
func main() {
r := gin.Default()
// This will respond to urls like search?firstname=Jane& lastname=Doe
r.GET("/search", func(c *gin.Context) {
// You need to call ParseForm() on the request to receive url and form params first
c.Request.ParseForm()
firstname := c.Request.Form.Get("firstname")
lastname := c.Request.Form.get("lastname")
message := "Hello "+ firstname + lastname
c.String(200, message)
})
r.Run(":8080")
}
```
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() {
2014-07-04 21:44:07 +04:00
r := gin.Default()
2014-06-18 03:42:34 +04:00
2014-07-04 21:44:07 +04:00
// Simple group: v1
v1 := r.Group("/v1")
{
v1.POST("/login", loginEndpoint)
v1.POST("/submit", submitEndpoint)
v1.POST("/read", readEndpoint)
}
// Simple group: v2
v2 := r.Group("/v2")
{
v2.POST("/login", loginEndpoint)
v2.POST("/submit", submitEndpoint)
v2.POST("/read", readEndpoint)
}
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
2014-06-18 03:42:34 +04:00
}
```
#### Blank Gin without middlewares by default
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 middlewares
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 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")
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"` .
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
2014-08-03 03:31:48 +04:00
// Binding from JSON
2014-06-18 03:42:34 +04:00
type LoginJSON struct {
2014-07-04 21:44:07 +04:00
User string `json:"user" binding:"required"`
Password string `json:"password" binding:"required"`
2014-06-18 03:42:34 +04:00
}
2014-08-03 03:31:48 +04:00
// Binding from form values
type LoginForm struct {
User string `form:"user" binding:"required"`
Password string `form:"password" binding:"required"`
}
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-08-03 03:31:48 +04:00
// Example for binding JSON ({"user": "manu", "password": "123"})
2015-01-01 19:06:02 +03:00
r.POST("/loginJSON", func(c *gin.Context) {
2014-07-04 21:44:07 +04:00
var json LoginJSON
2014-08-03 03:31:48 +04:00
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(200, gin.H{"status": "you are logged in"})
} else {
c.JSON(401, gin.H{"status": "unauthorized"})
}
2014-07-04 21:44:07 +04:00
})
2014-10-28 03:46:23 +03:00
// Example for binding a HTML form (user=manu& password=123)
2015-01-01 19:06:02 +03:00
r.POST("/loginHTML", func(c *gin.Context) {
2014-08-03 03:31:48 +04:00
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(200, gin.H{"status": "you are logged in"})
} else {
c.JSON(401, gin.H{"status": "unauthorized"})
}
})
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
}
```
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) {
c.JSON(200, gin.H{"message": "hey", "status": 200})
})
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(200, msg)
})
r.GET("/someXML", func(c *gin.Context) {
c.XML(200, gin.H{"message": "hey", "status": 200})
})
// 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
Use Engine.ServeFiles(path string, root http.FileSystem):
```go
func main() {
r := gin.Default()
r.Static("/assets", "./assets")
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
}
```
Note: this will use `httpNotFound` instead of the Router's `NotFound` handler.
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() {
2014-07-04 21:44:07 +04:00
r := gin.Default()
2015-01-05 18:15:42 +03:00
r.LoadHTMLGlob("templates/*")
2014-07-04 21:44:07 +04:00
r.GET("/index", func(c *gin.Context) {
obj := gin.H{"title": "Main website"}
c.HTML(200, "index.tmpl", obj)
})
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-18 03:42:34 +04:00
}
```
2015-01-05 18:15:42 +03:00
```html
< h1 >
{{ .title }}
< / h1 >
```
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() {
2014-07-04 21:44:07 +04:00
r := gin.Default()
html := template.Must(template.ParseFiles("file1", "file2"))
2014-12-02 17:28:38 +03:00
r.SetHTMLTemplate(html)
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-18 03:42:34 +04: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) {
2014-08-02 19:06:09 +04:00
c.Redirect(301, "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
#### Custom Middlewares
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
2014-07-04 06:47:34 +04:00
// similate 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"},
}
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) {
// get user, it was setted 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 {
2014-07-04 06:47:34 +04:00
c.JSON(200, gin.H{"user": user, "secret": secret})
2014-07-04 06:30:30 +04:00
} else {
2014-07-04 06:47:34 +04:00
c.JSON(200, 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
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
2014-08-19 12:38:03 +04:00
log.Println("Done! in path " + c_cp.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
})
// Listen and server on 0.0.0.0:8080
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
```