稳定的静态swagger接口服务

稳定的静态swagger接口服务
最新回答
偶遇制造者

2026-10-30 09:39:45

如果你有类似的疑问,这篇文章可以帮助你。

项目源码地址: github

出于稳定性考虑,在提测前不允许发布到测试环境,开发阶段如何保障swagger接口的稳定性?

在安装了docker的机器,通过 run.sh 可以执行镜像build及容器运行。

Dockerfile

就是一个 nginx 服务,提供了http访问json的能力。

Dockerfile

nginx.conf 中配置跨域操作 Access-Control-Allow-Origin *

static 目录下是接口json文件

通过 http://localhost:8080/v2/api-docs 获取json文件,命名后push到git项目 api 目录下

浏览器访问swagger-ui服务,并在窗口输入json文件访问路径 https://localhost:8080/demo_api_2.json ,然后就可以看到swagger接口定义。

看了一下 swagger-ui 的镜像实现,内部也是一个nginx,运行js。所以没必要自己搞一套nginx,直接把json文件copy到 swagger-ui 即可。

更新后到swagger服务Dockerfile如下

关于 缺陷2 可以考虑使用 API_URLS 环境变量实现,但是设置后,不能自定义输入jsonUrl

效果图如下