OpenAPITools / OpenAPITools/openapi-generator

[REQ] [go-gin-server] Add featureCORS option to enable CORS middleware

Open
#11,186 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Go-Gin-Server supporting file routers.go start a router without any cors configurations.

router := gin.Default()
for _, route := range routes {
  switch route.Method {
  case http.MethodGet:
	  router.GET(route.Pattern, route.HandlerFunc)
  case http.MethodPost:
	  router.POST(route.Pattern, route.HandlerFunc)
  case http.MethodPut:
	  router.PUT(route.Pattern, route.HandlerFunc)
  case http.MethodPatch:
	  router.PATCH(route.Pattern, route.HandlerFunc)
  case http.MethodDelete:
	  router.DELETE(route.Pattern, route.HandlerFunc)
  }
}

Describe the solution you'd like

Like Go-Server featureCORS option, cors configurations are added to router before route paths are holding, similar processing is required by Go-Gin-Server.

https://github.com/gin-contrib/cors

 router := gin.Default()
  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()

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Go-Gin-Server routers.go template and the existing Go-Server featureCORS option. Compare how that option is configured, then review gin-contrib/cors usage and determine how middleware must be applied before route registration. Done means generated Gin servers expose the option and apply the requested CORS configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.