springBoot值界面插件Swagger

1.首先要在pom.xml中引入swagger的依赖


   io.springfox
   springfox-swagger2
   2.8.0


   io.springfox
   springfox-swagger-ui
   2.8.0

2.在项目中添加swagger的配置项

import com.google.common.base.Predicate;
import org.springframework.boot.autoconfigure.web.BasicErrorController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
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 // 启用 Swagger
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        Predicate predicate = new Predicate() {
            @Override
            public boolean apply(RequestHandler input) {
                Class declaringClass = input.declaringClass();
                if (declaringClass == BasicErrorController.class)// 排除
                    return false;
                if(declaringClass.isAnnotationPresent(RestController.class)) // 被注解的类
                    return true;
                if(input.isAnnotatedWith(ResponseBody.class)) // 被注解的方法
                    return true;
                return false;
            }
        };
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //.host("ps.bonc.com.cn/api")
                .useDefaultResponseMessages(false)
                .select()
                .apis(predicate)
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
//                .title("包含媒体、咨询、搜索引擎关键字、广告等类型接口的服务")//大标题
//                .version("1.0")//版本
                .build();
    }
}

3.使用时只需要在controllerde 方法上加上@ApiOperation("方法描述")即可

4.在浏览器中的访问路径默认是   项目的访问路径/swagger-ui.html 

5.当然也是可以修改swagger的访问路径的  但是比较麻烦

可以参考https://blog.csdn.net/qq276726581/article/details/81135520 

 

你可能感兴趣的:(springBoot)