稳定的静态swagger接口服务
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了稳定的静态swagger接口服务相关的知识，希望对你有一定的参考价值。
参考技术A如果你有类似的疑问，这篇文章可以帮助你。
项目源码地址: 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
效果图如下
Swagger 自动生成 Dubbo 服务的接口文档，以及测试调用
管她前浪，还是后浪？
能浪的浪，才是好浪！
每天 8:55 更新文章，每天掉亿点点头发...
源码精品专栏
-
1. 概述 -
2. Swagger Dubbo -
3. 接入 Knife4j 作为 Swagger UI 界面 -
4. 接入 YApi 统一管理 -
666. 彩蛋
1. 概述
在使用 SpringMVC 构建 HTTP API 时，我们可以通过 Swagger 自动生成 HTTP 接口文档，通过 Swagger UI 界面上进行 HTTP 接口调试。如下图所示：
秃头提示：对 Swagger 不太了解的胖友，可以去阅读下艿艿写的 《芋道 Spring Boot API 接口文档 Swagger 入门》 文章。
开发体验杠杠的好！但是在使用 Dubbo 构建 RPC API 时，简直想要自闭。常常面临的痛苦是：
-
隔壁团队的老王，不肯给 Dubbo 写 接口文档，只能从他的 Dubbo API 的 jar包中寻寻觅觅想要的接口，贼不方便~ -
自己编写的每个 Dubbo API 接口，都需要写个 Controller 或者 Test 类去调用测试， 接口调试非常麻烦~
在一个逐步自闭到要爆炸的下午，艿艿做了一波 Dubbo 接口文档与接口调试的调研，想要尝试这块的痛点。结果比想象中顺利且简单，这不趁着这无聊到抠脚的周末，整理下分享给胖友。
以上是关于稳定的静态swagger接口服务的主要内容，如果未能解决你的问题，请参考以下文章
Springboot系列 集成接口文档swagger，使用，测试
Springboot系列 集成接口文档swagger，使用，测试