放弃Springfox,追随Springdoc
- 概述
- 快速开始
- 示例代码
- 1、配置类```OpenApiConfig.java```
- 2、创建2个不同的包,用来模拟多个微服务
- 3、```application.properties```配置
- 4、定义一个Controller的公共Response对象```R.java```
- 5、自定义异常类```CustomException.java```
- 6、统一异常处理类```GlobalControllerExceptionHandler.java```
- 7、Book包Controller类```BookController.java```
- 8、Book包DTO类```BookDTO.java```
- 9、Book包VO类```BookVO.java```
- 10、Store包Controller类```StoreController.java```
- 11、Store包DTO类```StoreDTO.java```
- 12、Store包VO类```StoreVO.java```
- 附录:Swagger2转Swagger3注解说明
- 项目Github地址
由于Springfox在2017年的时候就停更了,现在公司也正好想升级一下RestAPI,目前我们用的是Springfox的swagger2,本来想偷懒直接升级成Springfox的swagger3,但是最终失败了,页面一直加载不出接口,不知道什么原因,google了一圈都没找到答案,无奈放弃Springfox,转用Springdoc了。
1、添加依赖
项目pom.xml中添加依赖
2、启动项目,查看OpenAPI3.0的json文件
3、修改默认/v3/api-docs的访问路径
修改
修改后,可以通过下面的地址访问:
效果跟第2步是一样的
4、集成SwaggerUI
通过下面的地址访问
5、修改默认访问地址
修改
修改后,可以通过下面的地址访问:
效果跟第4步是一样的,这个地址并不是真正被修改,最终地址还是被重定向到 但是你不能直接访问这个地址,否则会展示OpenAPI3.0的演示UI页面,如下图所示:
6、启用分组配置
访问
1、配置类
2、创建2个不同的包,用来模拟多个微服务
3、配置
4、定义一个Controller的公共Response对象
5、自定义异常类
6、统一异常处理类
7、Book包Controller类
8、Book包DTO类
9、Book包VO类
10、Store包Controller类
11、Store包DTO类
12、Store包VO类
到此这篇swagger2配置security(swagger2config)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/rfx/54291.html