如何使用 Go-Swagger 在单个路由文件中生成版本化 API 的 Swagger 规范？

Question

我正在开发一个 Golang 项目，其中有一个后端服务器，在单个路由文件中定义了多个 API 版本。我正在使用 go-swagger 包来生成 Swagger 文档。

我的路线设置如下：

r := chi.NewRouter()

// swagger:operation POST /v1/resource AddResourceDetails
r.Post("/v1/resource", resourceHandler.AddResourceDetails)

// swagger:operation POST /v2/resource AddResourceDetails
r.Post("/v2/resource", resourceHandler.AddResourceDetails)

我想知道如何正确注释 Swagger 的处理函数，以便为每个 API 版本生成不同的规范文件。

Answer 1

使用以下模式将 v1、v2 标签添加到相关路由：

swagger:route [method] [path pattern] [?tag1 tag2 tag3] [operation id]

并在生成命令中添加

--include-tag=

选项，这将仅为给定标签生成规范文件。请注意，它可以指定多次。