swag init 报错： cannot find type definition: response.Response

原创已于 2022-02-15 17:14:18 修改 · 6.6k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#swagger

于 2022-02-15 16:54:37 首次发布

其他专栏收录该内容

15 篇文章

订阅专栏

本文介绍了如何在修改Go-admin配置并增加自定义接口后，正确处理Swagger文档解析外部依赖(response.Response)的问题，包括引入依赖、使用swag init命令及VSCode插件的自动化生成。

方法来源：https://www.jianshu.com/p/1837b37e03f8

go-admin 框架配置了swagger的，但是当我修改了内容，添加了自己的借口之后，想生成新的swagger文档，却报错了：

ParseComment error in file xxx :cannot find type definition: response.Response

然后看到接口上的定义swagger参数：

// ServerInfo 获取系统信息
// @Summary 系统信息
// @Description 获取JSON
// @Tags 系统信息
// @Success 200 {object} response.Response "{"code": 200, "data": [...]}"
// @Router /api/v1/server-monitor [get]
// @Security Bearer

这里的

@Success 200 {object} response.Response “{“code”: 200, “data”: […]}”

response.Response是外部依赖：“github.com/go-admin-team/go-admin-core/sdk/pkg/response”

在项目中，我看到已经引入该依赖：

import (
	_ "github.com/go-admin-team/go-admin-core/sdk/pkg/response"
)

因为并未实际应用了该依赖，所以要用横杆注释掉，但是它初始化了，就足够了。

查资料发现，原来还要加参数，才能识别到外部依赖：

swag init --parseDependency --parseInternal

PS ：后面才发现，原来go-admin人家准备好了，在main.go中：
在这里插入图片描述
vs code 有插件的话，直接点”run go generate“即可