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

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

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

方法来源: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“即可

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

lsjweiyi

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值