Go to file
Javier Provecho Fernandez 0202b02ec3 Merge pull request #7 from gin-contrib/new
Updates README
2016-10-31 09:50:56 +01:00
examples update readme for relase v1.0 2016-10-31 16:19:39 +08:00
.gitignore add git ignore file. 2016-10-19 09:47:01 -05:00
.travis.yml update testing version to 1.7.3 2016-10-21 14:05:40 +08:00
config.go import stable version of gin. 2016-10-31 08:52:00 +08:00
cors_test.go import stable version of gin. 2016-10-31 08:52:00 +08:00
cors.go import stable version of gin. 2016-10-31 08:52:00 +08:00
LICENSE add MIT License. 2016-10-20 08:57:33 +08:00
README.md update readme for relase v1.0 2016-10-31 16:19:39 +08:00
utils.go Renames some options 2015-11-12 15:14:38 +01:00

CORS gin's middleware

Build Status codecov Go Report Card GoDoc Join the chat at https://gitter.im/gin-gonic/gin

Gin middleware/handler to enable CORS support.

Usage

Start using it

  1. Download and install it:
$ go get gopkg.in/gin-contrib/cors.v1
  1. Import it in your code:
import "gopkg.in/gin-contrib/cors.v1"

Canonical example:

package main

import (
	"time"

	"gopkg.in/gin-contrib/cors.v1"
	"gopkg.in/gin-gonic/gin.v1"
)

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

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

func main() {
	router := gin.Default()
	// same as
	// config := cors.DefaultConfig()
	// config.AllowAllOrigins = true
	// router.Use(cors.New(config))
	router.Use(cors.Default())
	router.Run()
}