網頁

2024/3/17

Golang Swag 查詢字串參數列舉 @Param enums

Go swagger API文件的查詢字串(query string)參數的列舉(enums)說明設定方式如下。


事前要求

參考「Golang Swag @Param annotation格式」了解@Param的基本用法。


設定Enum

利用Atributeenums來設定列舉資訊。

例如下面設定query string timeUnit的列舉值為enums(minute, hour, day)

// @param timeUnit query string true "timeUnit" enums(minute, hour, day)

在swagger頁面顯示如下,下拉選單的值即為列舉值。




沒有留言:

張貼留言