如何在Go语言开发中正确配置Swagger文档以显示字段必填状态？-Golang-PHP中文网

如何在Go语言开发中正确配置Swagger文档以显示字段必填状态？

碧海醫心

发布： 2025-03-19 08:36:15

原创

682人浏览过

如何在go语言开发中正确配置swagger文档以显示字段必填状态？

Go Swagger文档：解决字段必填标识缺失

在Go语言开发中，使用Swagger生成API文档是常见的实践。然而，正确配置Swagger以显示字段的必填状态，常常会遇到挑战。本文将探讨如何解决Go Swagger文档中字段必填标识缺失的问题。

一个开发者反馈，其代码中已使用注释标注字段的必填属性，但生成的Swagger文档并未显示相应的必填标识（例如红色的*）。这引发了关于Swagger配置和必填字段标识的讨论。

以下为开发者提供的代码示例：

type LoginStructJson struct {
    UserId         string `json:"user_id" valid:"Required" structs:"user_id" binding:"required"` // 用户ID
    RegionId       string `json:"region_id" valid:"Required" structs:"region_id"`                // 地区ID        | 必填
    RegionName     string `json:"region_name" valid:"Required" structs:"region_name"`            // 地区名称        | 必填
    TimezoneId     string `json:"timezone_id" valid:"Required" structs:"timezone_id"`            // 时区ID        | 必填
    TimezoneName   string `json:"timezone_name" valid:"Required" structs:"timezone_name"`        // 时区名称        | 必填
    AreaServerId   string `json:"area_server_id" valid:"Required" structs:"area_server_id"`      // 区服ID        | 必填
    AreaServerName string `json:"area_server_name" valid:"Required" structs:"area_server_name"`  // 区服名称        | 必填
    ChannelId      string `json:"channel_id" valid:"Required" structs:"channel_id"`              // 渠道ID        | 必填
    ChannelName    string `json:"channel_name" valid:"Required" structs:"channel_name"`          // 渠道名称        | 必填
    GameId         int    `json:"game_id" valid:"Required" structs:"game_id"`                    // 游戏ID         | 必填
    GameName       string `json:"game_name" structs:"game_name"`                                 // 游戏名称
    EquipId        string `json:"equip_id" valid:"Required" structs:"equip_id"`                  // 设备ID          | 必填
    GamePlatform   int    `json:"game_platform" valid:"Min(0)" structs:"game_platform"`          // 平台类型         | 必填
    StopTime       int    `json:"stop_time" structs:"stop_time"`                                 // 停留时间      | 默认 0
}

//    @Summary    用户登录信息接口
//    @Tags        登录信息
//    @Produce    json
//    @Accept        json
//    @Param        param    body        LoginStructJson    true    "登录请求体"
//    @Success    200        {object}    app.Response
//    @Router        /api/dot/login/push [post]
func PushLoginInfo(c *gin.Context) {
}

登录后复制

经验丰富的开发者指出，Swagger文档中必填字段通常会自动显示为红色的*。如果未显示，可能是代码问题或Swagger框架解析错误。

立即学习“go语言免费学习笔记（深入）”；

此外，直接在代码中使用注释生成Swagger文档的方式（如使用swaggo等工具）存在一些缺点：框架更新缓慢，可能不支持最新的OpenAPI规范（例如OpenAPI 3.0或3.1），并且会增加代码的侵入性。

建议使用官方的Swagger Editor手动编写或使用更现代化的、与OpenAPI规范紧密结合的代码生成工具，这样可以更好地控制文档的生成过程，并确保必填字段的正确显示。手动编写虽然前期需要学习成本，但长期来看效率更高，且能避免因框架限制导致的文档错误。

以上就是如何在Go语言开发中正确配置Swagger文档以显示字段必填状态？的详细内容，更多请关注php中文网其它相关文章！