Golang Swag 查詢字串參數範例 @Param example

Go swagger API文件的查詢字串(query string)參數值的範例設定方式如下。

事前要求

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

設定範例

利用Atribute的example來設定參數值的範例資訊。

// @param startTime query string true "startTime" example(2024-03-15 09:00:00)

在swagger頁面顯示如下，出現Example : 2024-03-15 09:00:00。

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