swagger3.0使用及https问题处理

swagger 文档在日常开发中，用得比较多，往往我们都是手动配置，swagger3.0之后，直接就上了一个swagger-starter,用起来更方便了。swagger3.0发生了很多变化，比如包名、注解、访问路径等都有所变化。具体自己去体会了，我就是不多说了，直接开干。

swagger3.0项目地址: https://github.com/springfox/springfox

1.一个springboot项目

2.swagger3.0依赖

1.在springboot项目pom中添加入swagger3.0依赖

2.在启动类上加新版注解@EnableOpenApi

3.添加一个接口测试controller：

4.直接启动搞定： 注意 访问路径 http://localhost:8080/swagger-ui/index.html ，和2不一样了。

再一运行：

ok了，就搞定了。

当使用https后界面上的services地址不会随着你的项目域名变https时自动变https,如下图:

当然,这个bug官方会在3.0.1版本中修复, https://github.com/springfox/springfox/issues/3468 ，目前也是可以解决这个问题的，自定义swagger拦截器，借鉴了 https://github.com/springfox/springfox/issues/3531 ,

此时再重新启动项目:

就可以正常了，当然这只是我自己处理的一个思路，具体实现可以各抒己见。

最后的最后：demo地址: https://gitee.com/zzj1992/swagger3-demo.git

为什么要引入Swagger?

有过后台开发和前端联调的人都会被接口文档折磨，更新不及时，文档和代码不一致，无法调试，swagger就是为了解决这个问题。

看下swagger官方介绍

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

如此好的利器，怎么在后台框架中快速集成呢？

第一步、添加maven依赖

需要在系统的pom中添加如下依赖：

第二步、添加swagger配置文件

第三步、测试

浏览器输入：http://localhost:8080/swagger-ui.html ，能测试生成的api是否可用。

总结

很好用的开源框架，集成也很简单，建议大家在工程中使用，能够快速开发，减少前后端沟通api的时间成本。

- 打开用户控制器，默认显示用户控制器下3个API方法

- 打开添加用户信息后如下：

- 打开“通过用户名获取用户信息”，显示如下：

文章参考文献地址：

---