springboot3集成Swagger3

一、引入Swagger3的依赖

       <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

二、Swagger3的配置

package com.wzy.test.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
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;


@Configuration
@EnableSwagger2 //swagger3版本不需要使用这个注解，当然写上也无所谓~
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)  // swagger2版本这里是DocumentationType.SWAGGER_2
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXX管理平台")
                .description("XXXX管理平台 API接口文档")
                .license("小魏学习啦") //随便写个某公司都行
                .licenseUrl("www.xiaowei.com") // 可以写个某某网址
                .version("1.0")
                .build();
    }
}

三、由于MVC冲突可能出问题，在配置类加上@EnableWebMvc注解

四、设置完毕打开网址

http://localhost:端口号/swagger-ui/index.htmlhttp://localhost/swagger-ui/index.html

http://localhost:端口号/swagger-ui/index.html

五、Swagger提供的注解

1.@ApiModel（value = "XXX数据库名称的对象"）--->一般用在实体类的类上

2.@ApiModelProperty("意思")-------->一般用在数据库字段上用

3.@Api(tags = "") 一般用在Controller的类上

4.@ApiOperation(" ")  用在Controller的方法上