环境

gin + gin-swagger
main.go的位置为根目录下的cmd/main.go
在项目根目录下执行

swag init --parseDependency -g  .\cmd\main.go

执行完命令就会报错:

ParseComment error in file E:\workspace\XXXXXX\api.go  :cannot find type definition: web.APIError

解决方法

新增一个包名为web结构体名为APIError

package web

type APIError struct {
	ErrorCode    int
	ErrorMessage string
}

然后再次执行命令:

swag init --parseDependency -g  .\cmd\main.go

成功生产swagger文档
还需要在路由注册位置配置一下根路由
![在这里插入图片描述](https://img-blog.csdnimg.cn/ebbfbe6aa0e34c0b827a8b37961d9bc5.png在这里插入图片描述

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐