在 Go Swagger 中，你可以通过特定的注释格式来为 API 参数提供示例值。这些注释通常被放置在定义 API 请求和响应的结构体上方，或者使用特定的 Swagger 注释格式来标注路由处理器函数。以下是一些方法来为参数提供示例值：
在 Go 结构体中，你可以使用自定义的标签来为字段提供示例值。这些标签通常不会被 Go Swagger 直接识别，但你可以在生成 Swagger 文档后手动编辑它们，或者使用其他工具来处理这些标签。
goCopy Codepackage models type CreateUserRequest struct { // 用户名 Username string `json:"username" example:"john_doe"` // 密码 Password string `json:"password" example:"securepassword123"` }
在这个例子中，example 标签被用来为 Username 和 Password 字段提供示例值。然而，请注意，Go Swagger 默认可能不会处理这些标签。你可能需要编写额外的代码或脚本来将这些示例值包含到最终的 Swagger 文档中。
Go Swagger 支持一种特定的注释格式，你可以使用它来为 API 路由处理器函数中的参数提供示例值。这些注释通常被放置在函数上方，并且遵循一定的语法规则。
goCopy Codepackage main import ( "github.com/gin-gonic/gin" // ... 其他导入 ... ) // @Summary 创建用户 // @Description 创建新用户 // @Tags 用户 // @Accept json // @Produce json // @Param username body string true "用户名" example="john_doe" // @Param password body string true "密码" example="securepassword123" // @Success 201 {object} models.CreateUserResponse "用户创建成功" // @Failure 400 {object} gin.H "请求错误" // @Router /users [post] func CreateUser(c *gin.Context) { // ... 处理逻辑 ... }
在这个例子中，@Param 注释被用来为 POST /users 路由处理器函数中的 username 和 password 参数提供示例值。这些示例值将会出现在生成的 Swagger 文档中，帮助 API 使用者理解如何构造请求。
在生成 Swagger 文档后，你可以使用 Swagger UI 或 Swagger Editor 来查看和测试 API。这些工具通常允许你为请求参数提供示例值，并直接发送请求以测试 API。这些示例值不会保存在你的 Go 代码中，但它们对于 API 的调试和文档化非常有用。
请确保你正在使用的 Go Swagger 版本支持你想要的特性。Swagger 注释格式和工具支持可能会随着版本的更新而发生变化。此外，如果你的项目使用了特定的框架或库（如 Gin、Echo 等），你可能需要查阅该框架或库的文档以了解如何正确地使用 Swagger 注释。
Life is like a journey