使用路径参数生成路由的go-swagger规范

Question

我正在尝试使用Swagger2.0规范生成与昂首阔步兼容的json文档。

我在为path param的路由生成JSON文档时遇到了问题，如下所示：

PUT /foo/{bar}

目前我的godoc看起来是这样的：

// Update bar in foo
// swagger:route PUT /foo/{bar} updateBar
//     Parameters:
//       bar: barParam
//     Responses:
//       500: myErrorResponse
func (h *handler) update(req *http.Request, params martini.Params) (int, string)

结构化包装条参数：

// swagger:parameters barParam
type BarParam struct {

    // aaaa
    // in: path
    bar string
}

当我跑步时：

swagger generate spec -o ./swagger.json

生成的JSON当前如下所示：

    "/foo/{bar}": {
        "put": {
            "description": "bar: barParam",
            "operationId": "updateBar",
            "responses": {
                "500": {
                    "$ref": "#/responses/myErrorResponse"
                }
            },
            "summary": "Parameters:"
        }
    }

但是，我想生成以下JSON (兼容Swagger2.0)：

    "/v2/foo/{bar}": {
        "put": {
            "operationId": "updateBar",
            "responses": {
                "500": {
                    "$ref": "#/responses/myErrorResponse"
                }
            },
            "parameters": [
                {
                    "in": "path",
                    "name": "bar",
                    "description": "aaaa",
                    "required": true,
                    "type": "string"
                }
            ]
        }
    }

如何修改文档注释以实现这一目标？是否有任何文档描述了“昂首阔步”的准确注释格式？

Answer 1

尝试添加端点操作id ('updateBar')作为参数操作id。类似于：

// swagger:parameters updateBar
type BarParam struct {

    // aaaa
    // in: path
    bar string
}

并从端点swagger中删除“参数”。

Answer 2

如果要将条形图切换为小写，则必须设置：

// swagger:parameters updateBar
type BarParam struct {
    Bar string `json:"bar"`
}