Spring Boot 整合Swagger3.0

Spring Boot 整合Swagger3.0

整合步骤

 修改pom.xml文件，添加依赖

    io.springfox
    springfox-boot-starter
    3.0.0


    io.springfox
    springfox-swagger-ui
    3.0.0

 在启动类上添加@EnableOpenApi

 编写Swagger配置类

@Configuration
public class SwaggerConfig {
    /**
     * swagger3
     */
    @Bean
    public Docket desertsApi(){
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.qg.controller"))
                .paths(PathSelectors.any())
                .build()
                .groupName("desertsGroup")
                .enable(true);
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("抢购网Swagger3测试文档")
                .description("抢购网3文档描述信息")
                .contact(new Contact("孙博士", "#", "[email protected]"))
                .version("1.0")
                .build();
    }
}

 在需要接口文档的类上添加Swagger注解

 

 运行项目

 访问http://localhost:8082/swagger-ui/index.html

 

 测试程序功能

 

 

3.常用注解

swagger3的注解与swagger2相差很多，也兼容了swagger2的注解，区别如下：

 

三、使用knife4j优化体验

1.导入依赖

            com.github.xiaoymin
            knife4j-spring-boot-starter
            3.0.2

2.访问

直接访问http://localhost:8080/doc.html

 

 

导出文档：

 导出的文档格式如下图：

看起来就很舒适