93 lines
2.3 KiB
Markdown
93 lines
2.3 KiB
Markdown
# CORS gin's middleware
|
|
|
|
[](https://travis-ci.org/gin-contrib/cors)
|
|
[](https://codecov.io/gh/gin-contrib/cors)
|
|
[](https://goreportcard.com/report/github.com/gin-contrib/cors)
|
|
[](https://godoc.org/github.com/gin-contrib/cors)
|
|
[](https://gitter.im/gin-gonic/gin)
|
|
|
|
Gin middleware/handler to enable CORS support.
|
|
|
|
## Usage
|
|
|
|
### Start using it
|
|
|
|
Download and install it:
|
|
|
|
```sh
|
|
$ go get github.com/gin-contrib/cors
|
|
```
|
|
|
|
Import it in your code:
|
|
|
|
```go
|
|
import "github.com/gin-contrib/cors"
|
|
```
|
|
|
|
### Canonical example:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/gin-contrib/cors"
|
|
"github.com/gin-gonic/gin"
|
|
)
|
|
|
|
func main() {
|
|
router := gin.Default()
|
|
// CORS for https://foo.com and https://github.com origins, allowing:
|
|
// - PUT and PATCH methods
|
|
// - Origin header
|
|
// - Credentials share
|
|
// - Preflight requests cached for 12 hours
|
|
router.Use(cors.New(cors.Config{
|
|
AllowOrigins: []string{"https://foo.com"},
|
|
AllowMethods: []string{"PUT", "PATCH"},
|
|
AllowHeaders: []string{"Origin"},
|
|
ExposeHeaders: []string{"Content-Length"},
|
|
AllowCredentials: true,
|
|
AllowOriginFunc: func(origin string) bool {
|
|
return origin == "https://github.com"
|
|
},
|
|
MaxAge: 12 * time.Hour,
|
|
}))
|
|
router.Run()
|
|
}
|
|
```
|
|
|
|
### Using DefaultConfig as start point
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
// - No origin allowed by default
|
|
// - GET,POST, PUT, HEAD methods
|
|
// - Credentials share disabled
|
|
// - Preflight requests cached for 12 hours
|
|
config := cors.DefaultConfig()
|
|
config.AllowOrigins = []string{"http://google.com"}
|
|
config.AddAllowOrigins("http://facebook.com")
|
|
// config.AllowOrigins == []string{"http://google.com", "http://facebook.com"}
|
|
|
|
router.Use(cors.New(config))
|
|
router.Run()
|
|
}
|
|
```
|
|
|
|
### Default() allows all origins
|
|
|
|
```go
|
|
func main() {
|
|
router := gin.Default()
|
|
// same as
|
|
// config := cors.DefaultConfig()
|
|
// config.AllowAllOrigins = true
|
|
// router.Use(cors.New(config))
|
|
router.Use(cors.Default())
|
|
router.Run()
|
|
}
|
|
```
|