Go Swagge 文档为何无法显示必填字段？

Go Swagge 文档必填字段提示

Go 版本的 Swagger 文档生成工具因其必填字段提示方式而备受诟病。用户需要挨个点击字段，才能看到必填限制。

问题分析

在问题提交中，用户展示了一个类型结构体中的字段注释，其中使用了 valid、structs 和 binding 等约束，但 Swagger 生成的文档中未能反映这些必填限制。

解决方案

有两种方法可以解决这个问题：

• 确保注释正确：

  • 验证注释是否符合要求，例如 required 约束是否正确。

• 手动编写文档：

  • 推荐使用官方的 Swagger Editor 手动编写 API 文档。这需要学习 Swagger 语法，但胜在灵活性和可控性。

官方推荐

官方建议使用 Swagger Editor 手动编写 API 文档。这种方法虽然需要学习语法，但可以提供更好的控制和可定制性，并且避免了对源代码的侵入问题，同时也能支持最新的 OpenAPI 规范。

以上就是Go Swagge 文档为何无法显示必填字段？的详细内容，更多请关注其它相关文章！