dalu/cors
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme.

Browse Source 
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu 2016-10-19 20:51:59 +08:00
parent 34ed289f26
commit e33494abc7
1 changed files with 29 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,9 +1,17 @@
# CORS gin's middleware # CORS gin's middleware
[![Build Status](https://travis-ci.org/gin-contrib/cors.svg)](https://travis-ci.org/gin-contrib/cors)
[![codecov](https://codecov.io/gh/gin-contrib/cors/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-contrib/cors)
[![Go Report Card](https://goreportcard.com/badge/github.com/gin-contrib/cors)](https://goreportcard.com/report/github.com/gin-contrib/cors)
[![GoDoc](https://godoc.org/github.com/gin-contrib/cors?status.svg)](https://godoc.org/github.com/gin-contrib/cors)
[![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)
Gin middleware/handler to enable CORS support. Gin middleware/handler to enable CORS support.
## Usage ## Usage
###Canonical example: ### Canonical example:
```go ```go
package main package main
@ -37,38 +45,35 @@ func main() {
} }
``` ```
###Using DefaultConfig as start point ### Using DefaultConfig as start point
```go ```go
func main() { func main() {
router := gin.Default() router := gin.Default()
// - No origin allowed by default // - No origin allowed by default
// - GET,POST, PUT, HEAD methods // - GET,POST, PUT, HEAD methods
// - Credentials share disabled // - Credentials share disabled
// - Preflight requests cached for 12 hours // - Preflight requests cached for 12 hours
config := cors.DefaultConfig() config := cors.DefaultConfig()
config.AllowOrigins = []string{"http://google.com"} config.AllowOrigins = []string{"http://google.com"}
config.AddAllowOrigins("http://facebook.com") config.AddAllowOrigins("http://facebook.com")
// config.AllowOrigins == []string{"http://google.com", "http://facebook.com"} // config.AllowOrigins == []string{"http://google.com", "http://facebook.com"}
router.Use(cors.New(config)) router.Use(cors.New(config))
router.Run() router.Run()
} }
``` ```
###Default() allows all origins ### Default() allows all origins
```go ```go
func main() { func main() {
router := gin.Default() router := gin.Default()
// same as // same as
// config := cors.DefaultConfig() // config := cors.DefaultConfig()
// config.AllowAllOrigins = true // config.AllowAllOrigins = true
// router.Use(cors.New(config)) // router.Use(cors.New(config))
router.Use(cors.Default()) router.Use(cors.Default())
router.Run() router.Run()
} }
``` ```