我正在嘗試使用go-swagger生成符合Swagger2.0 規范的json API 文檔。我在為路徑參數生成 JSON 文檔時遇到問題，如下所示：PUT /foo/{bar}目前我的 godoc 看起來像這樣：// Update bar in foo// swagger:route PUT /foo/{bar} updateBar// Parameters:// bar: barParam// Responses:// 500: myErrorResponsefunc (h *handler) update(req *http.Request, params martini.Params) (int, string)結構包裹條參數：// swagger:parameters barParamtype 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" } ] } }如何修改 go-swagger 的文檔注釋以實現這一目標？是否有任何文檔描述了 go-swagger 的確切注釋格式？
2 回答
墨色風雨
TA貢獻1853條經驗 獲得超6個贊
嘗試添加您的端點操作 ID ('updateBar') 作為參數操作 ID。就像是：
// swagger:parameters updateBar
type BarParam struct {
// aaaa
// in: path
bar string
}
并從您的端點 swagger 文檔中刪除“參數”
開心每一天1111
TA貢獻1836條經驗 獲得超13個贊
如果要將 Bar 切換為小寫，則必須設置：
// swagger:parameters updateBar
type BarParam struct {
Bar string `json:"bar"`
}
- 2 回答
- 0 關注
- 437 瀏覽
添加回答
舉報
0/150
提交
取消