Spring Boot整合swagger
程序员文章站
2022-05-03 18:33:49
...
- 在pom.xml中引入swagger依赖包
- 添加Swagger配置类
在config下新建SwaggerConfig类,配置类代码如下(类的位置只要Spring能扫描并装载到就可以,类名称也是任意的):
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("对外开放接口API文档")
.description("HTTP对外开放接口")
.version("1.0.0")
.termsOfServiceUrl("http://xxx.xxx.com")
.license("LICENSE")
.licenseUrl("http://xxx.xxx.com")
.build();
}
}
Docket配置说明如下:
- RequestHandlerSelectors.any():请求处理器选择,也就是接口,这里指定所有接口。也可以使用RequestHandlerSelectors.basePackage(“controller包路径”)来指定,仅支持单个包。
- apiInfo():设置接口文档信息
ApiInfo配置说明如下:
- title:文档标题
- description:文档描述
- version:版本
- termsOfServiceUrl:服务条款URL
- license:许可证
- licenseUrl:许可证URL
- 另外还可以配置维护人信息(姓名、URL、email)等信息
-
配置拦截器
若项目有拦截器配置,需要在项目原有的拦截器配置中修改,忽略掉以下路径,以免被拦截导致无法访问。“swagger-ui.html”, “static/css/", "static/js/”, “swagger-resources”, “/**/error”, “v2/api-docs”
如: -
验证
完成配置后,在浏览器中打开url:http://{ip}:{port}/{project-name}/swagger-ui.html。出现如下页面说明配置成功
推荐阅读
-
spring boot踩坑记
-
spring boot从redis取缓存发生java.lang.ClassCastException异常
-
spring-boot-2.0.3不一样系列之源码篇 - run方法(三)之createApplicationContext,绝对有值得你看的地方
-
Spring Boot @Scheduled定时任务代码实例解析
-
Spring Boot认证:整合Jwt
-
Spring+Spring MVC+Mybatis 框架整合开发(半注解半配置文件)
-
Spring Boot 2整合Redis做缓存
-
spring boot加载资源路径配置和classpath问题解决
-
spring boot使用自定义的线程池执行Async任务
-
Spring Boot简介