Spring Boot整合swagger2接口文档教程和解说

酸菜鱼（szy）

已于 2023-02-28 17:31:03 修改

阅读量342

点赞数

文章标签： java spring boot

于 2020-07-08 12:07:56 首次发布

本文链接：https://blog.csdn.net/weixin_41677422/article/details/107202059

版权

java语言专栏收录该内容

42 篇文章 0 订阅

订阅专栏

Spring Boot整合swagger2接口文档教程和解说

1.Spring Boot项目引入swagger的依赖jar包，建议使用2.9.2版本，低版本可能不显示返回值的备注。

<!--swagger2-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

2.添加配置类

在这里插入图片描述

@Configuration
@EnableSwagger2
public class SwaggerConfig {
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title(“API接口文档”) //页面标题
.description(“接口管理”)//详细描述
.version(“1.0.0”) //版本号
.build();
}
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(“com.swagger.controller”)) //controller所在的包位置
.paths(PathSelectors.any())
.build();
}
}

这里提供一个配置类，首先通过@EnableSwagger2注解启用Swagger2，然后配置一个Docket Bean，这个Bean中，配置映射路径和要扫描的接口的位置，在apiInfo中，主要配置一下Swagger2文档网站的信息，例如网站的title，网站的描述，版本号，controller所在的包位置等等。

启动springboot项目
浏览器访问：http://localhost:8080/swagger-ui.html
端口为自己项目的端口
访问到的页面：
在这里插入图片描述