Go Swagge文档字段必填问题？

Question

为啥Go版的Swagger如此难用？

查看文档字段必填，还得挨个去点开？

这个是字段必填，这不就是我写了个注释么？

各位Go的大佬。是我写错了啊，还是说本身就这样啊，如果我写错了，请各位大佬指点一下，谢谢啦

---

@从君华 大哥，请指点一下，怎么能弄成你的那种？代码如下，已经在学swagger editor了，但现在这个还需要改一下

目前样式：

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) {

Answer 1

正常应该是这样的

必填参数后面会自带一个红色的*。

可能是你写错了，也可能是你用的框架解析错了。

不建议使用注释自动生成

一开始我们也是使用类似你现在用的直接从注释自动生成文档的框架（当时用的是swaggo），后面重构的时候发现这种三方的框架更新很慢，直到现在还不支持OpenAPI 3.0，更不要说OpenAPI 3.1了。同时我们发现，这种框架看起来很香，整体写下来，你会发现注释的代码量一样很大，同时还需要忍受对源代码的侵入问题。

综合考量后，最终采用手动编写接口文档的方式，工具就是官方的swagger editor，一开始确实需要一点点时间熟悉语法，但是掌握之后写起来不要太快，可以说是吊打注释生成的方式，同时以上列举的问题也全部解决，总之一个字，官方大法好！