Spring Boot集成 Swagger

Swagger集成文档具有以下几个优势:
1、功能丰富:支持多种注解,自动生成接口文档界面,支持在界面测试API接口功能。
2、及时更新:开发过程中花一点写注释的时间,就可以及时地更新API文档,省心省力。
3、整合简单:通过添加POM依赖和简单配置,内嵌于应用中就可同时发布API接口文档界面,不需要部署独立服务。
官方文档: https://swagger.io/docs/
官方网站:    https://swagger.io/

实现方法:

项目目录:

在这里插入图片描述

添加依赖

<!--    swagger    -->
<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>

创建配置类

在项目中新建config包,在该包下新建SwaggerConfig.java配置类。具体代码如下所示:

package com.wyq.springboot_swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 配置Swagger
 * @author Wyq
 * @date Jan 12, 2020
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder().build();
    }
}

页面测试

启动应用,在浏览器中访问 http://localhost:8080/swagger-ui.html,我们就可以看到Swagger的接口文档了。
在这里插入图片描述

发布了33 篇原创文章 · 获赞 7 · 访问量 3234

猜你喜欢

转载自blog.csdn.net/GaoXiR/article/details/103944030