vinchent/gin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/julienschmidt/gin into julienschmidt-master

Browse Source 
Conflicts:
	README.md
This commit is contained in:
Manu Mtz-Almeida 2014-07-04 21:37:33 +02:00
commit e2ecb03c16
1 changed files with 178 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

353
README.md
View File

@ -43,16 +43,18 @@ import "github.com/gin-gonic/gin"
#### Create most basic PING/PONG HTTP endpoint #### Create most basic PING/PONG HTTP endpoint
```go ```go
package main
import "github.com/gin-gonic/gin" import "github.com/gin-gonic/gin"
func main() { func main() {
r := gin.Default() r := gin.Default()
r.GET("/ping", func(c *gin.Context){ r.GET("/ping", func(c *gin.Context) {
c.String(200, "pong") c.String(200, "pong")
}) })
// Listen and server on 0.0.0.0:8080 // Listen and server on 0.0.0.0:8080
r.Run(":8080") r.Run(":8080")
} }
``` ```
@ -60,19 +62,19 @@ func main() {
```go ```go
func main() { func main() {
// Creates a gin router + logger and recovery (crash-free) middlewares // Creates a gin router + logger and recovery (crash-free) middlewares
r := gin.Default() r := gin.Default()
r.GET("/someGet", getting)
r.POST("/somePost", posting)
r.PUT("/somePut", putting)
r.DELETE("/someDelete", deleting)
r.PATCH("/somePatch", patching)
r.HEAD("/someHead", head)
r.OPTIONS("/someOptions", options)
// Listen and server on 0.0.0.0:8080 r.GET("/someGet", getting)
r.Run(":8080") r.POST("/somePost", posting)
r.PUT("/somePut", putting)
r.DELETE("/someDelete", deleting)
r.PATCH("/somePatch", patching)
r.HEAD("/someHead", head)
r.OPTIONS("/someOptions", options)
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
} }
``` ```
@ -80,23 +82,23 @@ func main() {
```go ```go
func main() { func main() {
r := gin.Default() r := gin.Default()
r.GET("/user/:name", func(c *gin.Context) {
name := c.Params.ByName("name")
message := "Hello "+name
c.String(200, message)
})
r.GET("/user/:name/:action", func(c *gin.Context) { r.GET("/user/:name", func(c *gin.Context) {
name := c.Params.ByName("name") name := c.Params.ByName("name")
action := c.Params.ByName("action") message := "Hello "+name
message := name + " is " + action c.String(200, message)
c.String(200, message) })
})
// Listen and server on 0.0.0.0:8080 r.GET("/user/:name/:action", func(c *gin.Context) {
r.Run(":8080") name := c.Params.ByName("name")
action := c.Params.ByName("action")
message := name + " is " + action
c.String(200, message)
})
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
} }
``` ```
@ -104,26 +106,26 @@ func main() {
#### Grouping routes #### Grouping routes
```go ```go
func main() { func main() {
r := gin.Default() r := gin.Default()
// 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 // Simple group: v1
r.Run(":8080") 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")
} }
``` ```
@ -145,35 +147,35 @@ r := gin.Default()
#### Using middlewares #### Using middlewares
```go ```go
func main() { func main() {
// Creates a router without any middleware by default // Creates a router without any middleware by default
r := gin.New() 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 // Global middlewares
// authorized := r.Group("/", AuthRequired()) r.Use(gin.Logger())
// exactly the same than: r.Use(gin.Recovery())
authorized := r.Group("/")
// per group middlewares! in this case we use the custom created // Per route middlewares, you can add as many as you desire.
// AuthRequired() middleware just in the "authorized" group. r.GET("/benchmark", MyBenchLogger(), benchEndpoint)
authorized.Use(AuthRequired())
{ // Authorization group
authorized.POST("/login", loginEndpoint) // authorized := r.Group("/", AuthRequired())
authorized.POST("/submit", submitEndpoint) // exactly the same than:
authorized.POST("/read", readEndpoint) authorized := r.Group("/")
// per group middlewares! in this case we use the custom created
// nested group // AuthRequired() middleware just in the "authorized" group.
testing := authorized.Group("testing") authorized.Use(AuthRequired())
testing.GET("/analytics", analyticsEndpoint) {
} authorized.POST("/login", loginEndpoint)
authorized.POST("/submit", submitEndpoint)
// Listen and server on 0.0.0.0:8080 authorized.POST("/read", readEndpoint)
r.Run(":8080")
// nested group
testing := authorized.Group("testing")
testing.GET("/analytics", analyticsEndpoint)
}
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
} }
``` ```
@ -182,30 +184,30 @@ func main() {
```go ```go
type LoginJSON struct { type LoginJSON struct {
User string `json:"user" binding:"required"` User string `json:"user" binding:"required"`
Password string `json:"password" binding:"required"` Password string `json:"password" binding:"required"`
} }
func main() { func main() {
r := gin.Default() r := gin.Default()
r.POST("/login", func(c *gin.Context) {
var json LoginJSON
// If EnsureBody returns false, it will write automatically the error
// in the HTTP stream and return a 400 error. If you want custom error
// handling you should use: c.ParseBody(interface{}) error
if c.EnsureBody(&json) {
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"})
}
}
})
// Listen and server on 0.0.0.0:8080 r.POST("/login", func(c *gin.Context) {
r.Run(":8080") var json LoginJSON
// If EnsureBody returns false, it will write automatically the error
// in the HTTP stream and return a 400 error. If you want custom error
// handling you should use: c.ParseBody(interface{}) error
if c.EnsureBody(&json) {
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"})
}
}
})
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
} }
``` ```
@ -213,34 +215,34 @@ func main() {
```go ```go
func main() { func main() {
r := gin.Default() r := gin.Default()
// gin.H is a shortcup for map[string]interface{}
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 // gin.H is a shortcup for map[string]interface{}
r.Run(":8080") 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")
} }
``` ```
@ -251,15 +253,15 @@ Using LoadHTMLTemplates()
```go ```go
func main() { func main() {
r := gin.Default() r := gin.Default()
r.LoadHTMLTemplates("templates/*") r.LoadHTMLTemplates("templates/*")
r.GET("/index", func(c *gin.Context) { r.GET("/index", func(c *gin.Context) {
obj := gin.H{"title": "Main website"} obj := gin.H{"title": "Main website"}
c.HTML(200, "index.tmpl", obj) c.HTML(200, "index.tmpl", obj)
}) })
// Listen and server on 0.0.0.0:8080 // Listen and server on 0.0.0.0:8080
r.Run(":8080") r.Run(":8080")
} }
``` ```
@ -267,13 +269,14 @@ You can also use your own html template render
```go ```go
import "html/template" import "html/template"
func main() {
r := gin.Default()
html := template.Must(template.ParseFiles("file1", "file2"))
r.HTMLTemplates = html
// Listen and server on 0.0.0.0:8080 func main() {
r.Run(":8080") r := gin.Default()
html := template.Must(template.ParseFiles("file1", "file2"))
r.HTMLTemplates = html
// Listen and server on 0.0.0.0:8080
r.Run(":8080")
} }
``` ```
@ -282,39 +285,39 @@ func main() {
```go ```go
func Logger() gin.HandlerFunc { func Logger() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
t := time.Now() t := time.Now()
// Set example variable // Set example variable
c.Set("example", "12345") c.Set("example", "12345")
// before request // before request
c.Next() c.Next()
// after request // after request
latency := time.Since(t) latency := time.Since(t)
log.Print(latency) log.Print(latency)
// access the status we are sending // access the status we are sending
status := c.Writer.Status() status := c.Writer.Status()
log.Println(status) log.Println(status)
} }
} }
func main() { func main() {
r := gin.New() r := gin.New()
r.Use(Logger()) r.Use(Logger())
r.GET("/test", func(c *gin.Context){ r.GET("/test", func(c *gin.Context) {
example := c.MustGet("example").(string) example := r.Get("example").(string)
// it would print: "12345" // it would print: "12345"
log.Println(example) log.Println(example)
}) })
// Listen and server on 0.0.0.0:8080 // Listen and server on 0.0.0.0:8080
r.Run(":8080") r.Run(":8080")
} }
``` ```
@ -396,23 +399,23 @@ Use `http.ListenAndServe()` directly, like this:
```go ```go
func main() { func main() {
router := gin.Default() router := gin.Default()
http.ListenAndServe(":8080", router) http.ListenAndServe(":8080", router)
} }
``` ```
or or
```go ```go
func main() { func main() {
router := gin.Default() router := gin.Default()
s := &http.Server{ s := &http.Server{
Addr: ":8080", Addr: ":8080",
Handler: router, Handler: router,
ReadTimeout: 10 * time.Second, ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second, WriteTimeout: 10 * time.Second,
MaxHeaderBytes: 1 << 20, MaxHeaderBytes: 1 << 20,
} }
s.ListenAndServe() s.ListenAndServe()
} }
``` ```