今天在用go swag生成接口文档,遇到一个报错:cannot find type definition. 很奇怪,然后搜了一下,发现有解决的办法,那就是加上 参数
完整的参数如下:
swag init --parseDependency --parseInternal
这两个参数是什么意思呢?
第一个参数 parseDependency 是让swag智能分析项目代码中的依赖,并在生成代码文档的时候,用这些依赖来补足can not find type definition的状况
parseInternal 参数,明确告诉swag,你可以参考 没有Export暴露出来的内部struct或者方法来生成文档。
结合这两个参数,就能帮助你,完整的生成具体的文档
如果你用go generate命令帮助生成文档,你可以在你的main.go 函数加上一条指令
示例代码:
//go:generate swag init --parseDependency --parseInternal//go:generatefunc main() {这样当你构建编译之前,执行go generate,就可以帮你自动生成对应的文档