Go Swagge 文档生成：如何标记字段为必填？

go swagge 文档生成疑问：字段是否必填

问题描述

在使用 go 版 swagge 生成文档时，发现字段必填的问题需要挨个点开查看。同时，标记字段为必填的注释内容与生成的文档不一致，令人困惑。

原因分析

造成此问题的可能原因如下：

• 注释错误：确保字段上的注释符合 swagge 识别的语法规则。
• 框架解析问题：所使用的框架可能无法正确解析注释中的必填信息。

解决方案

正确编写注释：

使用 json: 标签指定字段名称。对于必填字段，添加 valid:"required" 约束。例如：

type LoginStructJson struct {
    UserId         string `json:"user_id" valid:"Required"`
    // 其他字段...
}

避免注释自动生成：

不建议使用注释自动生成文档的方式，因为它会引入代码侵入问题并且可能导致更新不及时。

使用 swagger editor 手动编写：

推荐使用官方的 swagger editor 手动编写接口文档。虽然需要花费一些时间熟悉语法，但可以获得更好的控制和更全面的描述。

步骤：

1. 安装 swagger editor
2. 创建一个 openapi 文档
3. 为每个操作定义输入和输出模型
4. 根据需要添加响应代码和说明

这样生成的文档将具有清晰的必填字段标记，并且不会产生注释代码。

以上就是Go Swagge 文档生成：如何标记字段为必填？的详细内容，更多请关注其它相关文章！