swagger
(5)通过 Makefile 及 ssh 远程执行命令,实现服务器线上服务的自动部署
最近一直写接口文档,基于 [swaggo](/tag/swagger) 实现的文档服务。由于要跟前端配合,所以每天都要频繁更新接口文档,非常麻烦。之前是半自动化状态:
1. makefile 中 scp 文档程序到服务器
2. 手动
swaggo 通过 tag 限制生成接口文档的范围
这个周都在写 swaggo 接口文档,起因是要迁移一个旧的 golang gin 后台接口服务,新的系统只需要用到部分原有系统的接口。
但是,为了预防未来可能功能扩展,还是想继续保留原有系统的接口文档,不做删除处理。
那么,在用
gin.BasicAuth 为生产环境 Swagger UI 文档加上密码保护
虽然大家都推荐将 Swagger 接口文档服务部署在开发环境,但是由于现公司前后端开发人员异地办公,我还是倾向于将 swaggo 服务部署在生产环境。加上个简单的账号密码访问限制即可。
## 方案选型
- [Nginx auth](
go-swagger 生成 API 文档,及与 swaggo 的对比
## go-swagger 与 swaggo 对比
最终没有选择 go-swagger,还是回归了 [swaggo](https://www.sunzhongwei.com/use-swaggo-and-gin-swagger-to-ge
使用 swaggo 及 gin-swagger 生成 API 文档
好久没有给别人写接口了,正好遇到一个前后端合作的项目,是时候尝试一下 golang swagger 的 API 文档生成工具了。
注意:尝试了 swaggo 之后,感觉很不好(注释规范口味太重,与三方库有冲突),我觉得再试试 [go-
上一页
下一页