0

0

Go Swagger 文档如何标识必填字段?

霞舞

霞舞

发布时间:2024-11-11 11:12:10

|

637人浏览过

|

来源于php中文网

原创

go swagger 文档如何标识必填字段?

go swagger 文档字段必填问题

有开发者反映,go 版的 swagger 在使用时遇到困难,遇到的具体问题是字段标注为必填,但查看文档时需要逐个点开才能确认。

必填字段标识

正常情况下,必填参数会在文档中显示一个红色星号(*)。

错误示例 (注释自动生成)

百度GBI
百度GBI

百度GBI-你的大模型商业分析助手

下载
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
}

正确示例 (手动编写)

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

建议不使用注释自动生成

建议不要使用注释自动生成文档的方式,其缺点如下:

  • 三方框架更新缓慢,无法支持最新的 openapi 标准。
  • 注释代码量的实际并不减少。
  • 会对源代码造成侵入。

推荐使用官方提供的 swagger editor 工具手动编写接口文档。

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1050

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

86

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

457

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

11

2026.01.19

Golang 性能分析与pprof调优实战
Golang 性能分析与pprof调优实战

本专题系统讲解 Golang 应用的性能分析与调优方法,重点覆盖 pprof 的使用方式,包括 CPU、内存、阻塞与 goroutine 分析,火焰图解读,常见性能瓶颈定位思路,以及在真实项目中进行针对性优化的实践技巧。通过案例讲解,帮助开发者掌握 用数据驱动的方式持续提升 Go 程序性能与稳定性。

9

2026.01.22

html编辑相关教程合集
html编辑相关教程合集

本专题整合了html编辑相关教程合集,阅读专题下面的文章了解更多详细内容。

56

2026.01.21

三角洲入口地址合集
三角洲入口地址合集

本专题整合了三角洲入口地址合集,阅读专题下面的文章了解更多详细内容。

28

2026.01.21

AO3中文版入口地址大全
AO3中文版入口地址大全

本专题整合了AO3中文版入口地址大全,阅读专题下面的的文章了解更多详细内容。

383

2026.01.21

妖精漫画入口地址合集
妖精漫画入口地址合集

本专题整合了妖精漫画入口地址合集,阅读专题下面的文章了解更多详细内容。

115

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号