处理具有不同 API 版本的同一终点的有效方法

为了有效管理具有相同端点的不同 API 版本，本文探索了两种方法。第一种方法涉及在端点 URL 中添加版本前缀，这是一种常见做法。然而，如果您希望避免添加前缀，本文建议使用中间件来实现版本控制。这种方法可以通过检查请求头中的“Accept-Version”字段来动态确定版本。本文还提供了 Gin 框架中的示例代码，展示了如何使用中间件实现版本控制。

我正在寻找一种干净的方法来维护具有相同端点的 api 的两个版本。

现在，最简单但似乎过多的方法是拥有类似的东西

r := chi.newrouter()
  r.get("/test", func(w http.responsewriter, r *http.request) {
    version := r.header.get("accept-version")
    if version == "v1" {
      w.write([]byte("version 1 of api"))
    } else {
      w.write([]byte("other version of api"))
    }
  })

但是当您有几十个左右端点时......可能会变得混乱

我想要的方式是拥有一个中间件，该中间件将直通到下一个定义的路由。所以类似

r := chi.NewRouter()
  r.With(UseVersion1).Get("/test", func(w http.ResponseWriter, r *http.Request) {
      w.Write([]byte("version 1 of api"))
    }
  })
  r.With(UseVersion2).Get("/test", func(w http.ResponseWriter, r *http.Request) {
      w.Write([]byte("other version of api"))
    }
  })

这可能吗？或者有人可以建议更好的路线（不是双关语）

编辑：我知道为路径添加前缀是一个可行的选择。我想避免这种情况

正确答案

alexmac是对的，通常我们使用前缀，如果你不想添加前缀，也可以使用中间件（ps：不推荐）

你的代码有问题，一个url不能使用多个中间件

以下是 gin 中的示例，在 chi 中，您可以自己编写代码：

package main

import (
    "github.com/gin-gonic/gin"
)

func version() gin.handlerfunc {
    return func(c *gin.context) {

        if c.request.requesturi[:2] != "/v" {
            version := c.getheader("accept-version")
            if version == ""{
                version = "v2"
            }
            c.redirect(302, "/" + version + c.request.requesturi)
            c.abort()
        }else{
            c.next()
        }
    }
}

func main() {
    r := gin.new()
    r.use(version())
    v1 := r.group("v1")
    v2 := r.group("v2")

    v1.get("/test", func (c *gin.context){
        c.string(200, "v1 test")
    })
    v2.get("/test", func (c *gin.context){
        c.string(200, "v2 test")
    })

    // listen and serve on 0.0.0.0:8080
    r.run(":8080")
}

如果您不想更改网址，您可以：

package main

import (
    "github.com/gin-gonic/gin"
)
var(
    r *gin.Engine
)
func Version() gin.HandlerFunc {
    return func(c *gin.Context) {
        if c.Request.URL.Path[:2] != "/v" {
            version := c.GetHeader("Accept-version")
            if version == ""{
                version = "v2"
            }
            c.Request.URL.Path = "/" + version + c.Request.RequestURI
            r.HandleContext(c)
            c.Abort()
        }
        c.Next()
    }
}

func main() {
    r = gin.New()
    r.Use(Version())
    v1 := r.Group("v1")
    v2 := r.Group("v2")
    v1.GET("/test", func (c *gin.Context){
        c.String(200, "v1/test")
    })
    v2.GET("/test", func (c *gin.Context){
        c.String(200, "v2/test")
    })

    // Listen and serve on 0.0.0.0:8080
    r.Run(":8080")
}

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。