如何在 go 光纤路由器函数中声明 swagger 属性

Question

我使用光纤摇摆包生成摇摆文档。我已经对仅在其域中使用的路由进行了分组。当我在函数上方进行声明时，它工作得很好// GetDevices godoc// @Summary Get all Devices// @ID get-all-devices// @Description Get all Devices// @Accept  json// @Produce  json// @Tags Devices End Points// @Success 200 {object} models.Device// @Failure 400 {object} utils.HTTPError// @Failure 404 {object} utils.HTTPError// @Failure 500 {object} utils.HTTPError// @Router /api/devices/ [get]func DeviceRoute(route fiber.Router) {    route.Get("", controllers.GetDevices)     route.Post("/create", services.CheckMiddleware, controllers.CreateDevice)}但是，我希望对每条路线进行每个swagger声明，但是当我执行以下操作时，这不起作用func DeviceRoute(route fiber.Router) {    // GetDevices godoc// @Summary Get all Devices// @ID get-all-devices// @Description Get all Devices// @ID get-item-by-int// @Accept  json// @Produce  json// @Tags Devices End Points// @Success 200 {object} models.Device// @Failure 400 {object} utils.HTTPError// @Failure 404 {object} utils.HTTPError// @Failure 500 {object} utils.HTTPError// @Router /api/devices/ [get]    route.Get("", controllers.GetDevices)    // Create Device godoc// @Summary Create a device// @ID create-device// @Description  Create a device// @Accept  json// @Produce  json// @Tags Devices// @param device body models.Device true  "Device details"// @Success 200 {object} Device// @Failure 400 {object} utils.HTTPError// @Failure 404 {object} utils.HTTPError// @Failure 500 {object} utils.HTTPError// @Router /api/devices/create [post]     route.Post("/create", services.CheckMiddleware, controllers.CreateDevice)}当我按照上述方式执行时，我得到规范中定义的操作！对于从使用光纤的函数公开和访问的每个路由，我应该如何执行此操作。路由器？注意：当我运行 swag init 时，当定义位于设备路由函数中时，json 文件的输出如下所示"info": {        "description": "Teleops IOT server API",        "title": "Teleops  API",        "contact": {            "name": "API Support",            "email": "[e-mail]"        },        "version": "2.0"    },    "host": "localhost:3000",    "basePath": "/",    "paths": {}}

Answer 1

文档生成器不会查看函数内部，只会查看函数外部。您最好重新构建路由以允许这样做，例如，有一个服务器类型来定义路由调用以执行其功能的方法。