go swagge文档字段必填问题?
内容
希望使用go swagge生成api文档,但遇到以下问题:
文档中字段必填选项需要手动点开才能查看
注释中已标记必填,文档中却未显示红色星号
解决方案
1. 确认代码正确
确保代码中已正确使用验证标记,例如:
2. 使用官方工具
建议使用go官方提供的swagger editor生成api文档。
优点
官方工具,更新速度快
支持openapi 3.0和3.1
手动编写,不会侵入源代码
效率高,语法简单
使用步骤
打开swagger editor (https://editor.swagger.io/)
创建新文档
在“paths”中添加路径和操作
在“parameters”中添加请求参数
在“schema”中定义对象模型
完成以上步骤,即可生成包含所有必需字段描述的swagger文档。
// RegionId 地区ID | 必填
RegionId string `json:"region_id" valid:"Required"`