go-swagger 生成文档时，使用 json.RawMessage 时遇到错误

积累知识，胜过积蓄金银！毕竟在Golang开发的过程中，会遇到各种各样的问题，往往都是一些细节知识点还没有掌握好而导致的，因此基础知识点的积累是很重要的。下面本文《go-swagger 生成文档时，使用 json.RawMessage 时遇到错误》，就带大家讲解一下知识点，若是你对本文感兴趣，或者是想搞懂其中某个知识点，就请你继续往下看吧~

我有一个带有 swagger 文档生成功能的 go web 应用程序。最近在我的项目中添加了新端点，该端点在 post 和 put 请求中使用以下结构：

Secret struct {
        // Secret unique key name.
        Name string `json:"name" example:"ACCESS_TOKEN"`

        // type: string
        // x-go-type: "string"
        Value json.RawMessage `json:"value" swagger:"type:string"`

        // Tags in which this secret is used.
        Tags []string `json:"tags" example:"dev,prod,omitempty"`
    }

当我尝试使用命令构建 swagger 文档时：swag init -md ./documentation -o ./swagger 我收到以下错误：

如果我正确理解，应该明确添加 type 定义 ，但我不明白如何正确定义类型，所有注释组合都不起作用。此问题与 json.rawmessage 类型（值字段）相关，因为如果我用 interface{} 替换此类型，一切正常。

正确答案

我找到了我的问题的解决方案，以前我必须省略使用 --parsedependency 因为 swagger 文档生成挂起，但如果我同时传递 --parsedepth 1 我的文档成功生成，所以完整的命令是：

swag init --parsedependency --parseinternal --parsedepth 1 -md ./documentation -o ./swagger

据我了解，出现这种情况是因为 json.rawmessage 需要导入，但如果我没有使用 --parsedependency json.rawmessage 类型，则无法找到，但在我的问题案例中，单个 --parsedependency 挂起，所以它无法使用。解决方案是使用 --parsedepth 参数

当我生成 swagger 文档并发现类型 json.rawmessage 找不到其类型定义时，我还在it中使用了 swag。 我的cmd是这样的：

swag init --parsedependency -g ./main.go

如果我只是将 --parsedepth 1 添加到我的 cmd 中（如上面的答案）。仍然会出现同样的错误。
当我将 --parseinternal 添加到我的 cmd 时。终于成功了。因为如果要解析内部包中定义的类型，则需要在 cmd 中使用 --parseinternal 。所以完整的cmd是这样的：

swag init --parseDependency --parseInternal -g ./main.go

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。