swaggo 通过 tag 限制生成接口文档的范围

这个周都在写 swaggo 接口文档，起因是要迁移一个旧的 golang gin 后台接口服务，新的系统只需要用到部分原有系统的接口。

但是，为了预防未来可能功能扩展，还是想继续保留原有系统的接口文档，不做删除处理。

那么，在用 swaggo 生成接口文档的时候，就出现了问题。如何屏蔽掉不需要的接口文档？

看起来很简单，直接用 exclude 参数不就行了？实际测试，这个 exclude 参数只支持目录，不支持具体文件，虽然帮助文档里写是支持具体文件，但是即便更新了最新版本的 swaggo，也是不生效。

后来发现新版本支持了 tags 来指定生成文档。这就满足需求了，而且 tag 控制精度比排除文件更精准。

需要注意的是，需要把 swaggo 升级到最新版本。

命令

例如，这里指定了三个标签，用逗号分割。

swag init --output api_docs --tags "设备管理,模式管理,代理商管理" --parseDependency --parseInternal --parseGoList=false --parseDepth=1

我是来自山东烟台的一名开发者，有感兴趣的话题，或者软件开发需求，欢迎加微信 zhongwei 聊聊，或者关注我的个人公众号“大象工具”，查看更多联系方式