springboot2.2.6集成swagger-ui(以及使用bootstrap-ui）

最新推荐文章于 2024-08-21 16:33:32 发布

温水煮蚂蚁

最新推荐文章于 2024-08-21 16:33:32 发布

阅读量2.2k

点赞数 2

分类专栏： Springboot 文章标签： swagger

本文链接：https://blog.csdn.net/xinshijimanon/article/details/105862284

版权

Springboot 专栏收录该内容

5 篇文章 1 订阅

订阅专栏

1、在pom文件中加入以下依赖

		<!-- swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger-ui.version}</version>
        </dependency>
        <!-- swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <!-- 引入swagger-bootstrap-ui包 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>${swagger-bootstrap-ui.version}</version>
        </dependency>

这里我用的各依赖版本如下：

 		<swagger-ui.version>2.9.2</swagger-ui.version>
        <swagger2.version>2.9.2</swagger2.version>
        <swagger-bootstrap-ui.version>1.8.5</swagger-bootstrap-ui.version>

2、加入SwaggerConfig配置类

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;

/**
 * SwaggerConfig
 * @desc: Swagger配置
 * @version:
 * @createTime: 2020/4/23 11:08
 * @author: 
 */
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createH5RestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("智慧生态api文档")
                .description("restful 风格接口")
                .version("1.0")
                .build();
    }

}

3、启动类上加上`@EnableSwagger2`、以及`@EnableSwaggerBootstrapUI`注解

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * SmartEcologyApplication
 * @desc: TODO 类的设计目的、功能及注意事项
 * @version:
 * @createTime: 2020/4/22 16:16
 * @author: 
 */
@EnableSwaggerBootstrapUI
@EnableSwagger2
@SpringBootApplication
public class SmartEcologyApplication {

    public static void main(String[] args) {
        SpringApplication.run(SmartEcologyApplication.class, args);
    }

}