swagger3.0使用及https问题处理

swagger3.0使用及https问题处理,第1张

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

Spring Boot 集成 Swagger

1、添加依赖

Maven依赖示例:

2、在 Spring Boot 配置文件中添加配置参数。

3、添加配置类

如何使用

Swagger 默认会根据配置的包,扫描所有接口并生成对应的 API 描述和参数信息,但这样不是很直观,需要对每个接口和参数进行自定义描述。

常用的 Swagger 注解如下。

使用示例如:

http://localhost:8080/swagger-ui.html

打开 swagger-ui 界面,可以看到所有的 API 接口定义,也可以在上面发起接口测试。

34张架构史上最全技术知识图谱


欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/bake/11648887.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2023-05-17
下一篇2023-05-17

发表评论

登录后才能评论

评论列表(0条)

    保存