diff options
Diffstat (limited to 'vendor/github.com/gin-contrib/cors/README.md')
-rw-r--r-- | vendor/github.com/gin-contrib/cors/README.md | 87 |
1 files changed, 44 insertions, 43 deletions
diff --git a/vendor/github.com/gin-contrib/cors/README.md b/vendor/github.com/gin-contrib/cors/README.md index bd567b10b..6289994d0 100644 --- a/vendor/github.com/gin-contrib/cors/README.md +++ b/vendor/github.com/gin-contrib/cors/README.md @@ -1,10 +1,9 @@ # CORS gin's middleware -[](https://travis-ci.org/gin-contrib/cors) +[](https://github.com/gin-contrib/cors/actions/workflows/go.yml) [](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. @@ -15,7 +14,7 @@ Gin middleware/handler to enable CORS support. Download and install it: ```sh -$ go get github.com/gin-contrib/cors +go get github.com/gin-contrib/cors ``` Import it in your code: @@ -24,37 +23,37 @@ Import it in your code: import "github.com/gin-contrib/cors" ``` -### Canonical example: +### Canonical example ```go package main import ( - "time" + "time" - "github.com/gin-contrib/cors" - "github.com/gin-gonic/gin" + "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() + 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() } ``` @@ -62,30 +61,32 @@ func main() { ```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.AllowOrigins == []string{"http://google.com", "http://facebook.com"} - - router.Use(cors.New(config)) - router.Run() + 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.AllowOrigins = []string{"http://google.com", "http://facebook.com"} + // config.AllowAllOrigins = true + + router.Use(cors.New(config)) + router.Run() } ``` +note: while Default() allows all origins, DefaultConfig() does not and you will still have to use AllowAllOrigins ### 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() + router := gin.Default() + // same as + // config := cors.DefaultConfig() + // config.AllowAllOrigins = true + // router.Use(cors.New(config)) + router.Use(cors.Default()) + router.Run() } ``` |