Go Swagge文档字段必填问题?
来源:SegmentFault
时间:2023-03-11 09:49:30 216浏览 收藏
从现在开始,努力学习吧!本文《Go Swagge文档字段必填问题?》主要讲解了等等相关知识点,我会在golang学习网中持续更新相关的系列文章,欢迎大家关注并积极留言建议。下面就先一起来看一下本篇正文内容吧,希望能帮到你!
问题内容
为啥Go版的Swagger如此难用?

查看文档字段必填,还得挨个去点开?


这个是字段必填,这不就是我写了个注释么?
各位Go的大佬。是我写错了啊,还是说本身就这样啊,如果我写错了,请各位大佬指点一下,谢谢啦
@从君华 大哥,请指点一下,怎么能弄成你的那种?代码如下,已经在学
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) {
正确答案
正常应该是这样的

必填参数后面会自带一个红色的*。
可能是你写错了,也可能是你用的框架解析错了。
不建议使用注释自动生成
一开始我们也是使用类似你现在用的直接从注释自动生成文档的框架(当时用的是swaggo),后面重构的时候发现这种三方的框架更新很慢,直到现在还不支持
OpenAPI 3.0,更不要说
OpenAPI 3.1了。同时我们发现,这种框架看起来很香,整体写下来,你会发现注释的代码量一样很大,同时还需要忍受对源代码的侵入问题。
综合考量后,最终采用手动编写接口文档的方式,工具就是官方的
swagger editor,一开始确实需要一点点时间熟悉语法,但是掌握之后写起来不要太快,可以说是吊打注释生成的方式,同时以上列举的问题也全部解决,总之一个字,官方大法好!
今天关于《Go Swagge文档字段必填问题?》的内容就介绍到这里了,是不是学起来一目了然!想要了解更多关于mysql的内容请关注golang学习网公众号!
声明:本文转载于:SegmentFault 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
-
502 收藏
-
502 收藏
-
501 收藏
-
501 收藏
-
501 收藏
最新阅读
更多>
-
139 收藏
-
204 收藏
-
325 收藏
-
477 收藏
-
486 收藏
-
439 收藏
-
357 收藏
-
352 收藏
-
101 收藏
-
440 收藏
-
212 收藏
-
143 收藏
课程推荐
更多>
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 508次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习