【SpringBoot】集成swagger

1、引入依赖

<!--swagger-->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version>
</dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.7.0</version>
</dependency>

2、配置header（若有token的话，可以采用如下配置）

3、配置包扫描多路径

import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import com.example.demo.constant.StringConstant;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;import java.util.ArrayList;
import java.util.List;/*** @className Swagger* @description swagger集成配置类* @author zlt* @date 2018/10/23* @version 1.0.0* @remark**/
@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig extends WebMvcConfigurerAdapter {@Beanpublic Docket createRestApi() {//在请求header头部添加token参数ParameterBuilder ticketPar = new ParameterBuilder();List<Parameter> pars = new ArrayList<>();//name表示名称，description表示描述ticketPar.name(StringConstant.HEAD_TOKEN).description("登录校验token").modelRef(new ModelRef("string")).parameterType("header")//required表示是否必填.required(false).defaultValue("TOKEN默认值").build();pars.add(ticketPar.build());return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//可以配置多个包扫描路径.apis(SwaggerConfig.basePackage("com.example.demo.controller.department,com.example.demo.controller.user")).paths(PathSelectors.any()).build()//header配置在全局生效.globalOperationParameters(pars);}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("XXX接口文档").description("").termsOfServiceUrl("").version("1.0").build();}@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}/*** @methodName basePackage* @description* @author zlt* @date 2018/10/29* @param basePackage 多个包名以逗号隔开* @return com.google.common.base.Predicate<springfox.documentation.RequestHandler>* @version 1.0.0**/public static Predicate<RequestHandler> basePackage(final String basePackage) {return new Predicate<RequestHandler>() {@Overridepublic boolean apply(RequestHandler input) {return declaringClass(input).transform(handlerPackage(basePackage)).or(true);}};}/*** @methodName handlerPackage* @description 处理包路径配置规则,支持多路径扫描匹配以逗号隔开* @author zlt* @date 2018/10/29* @param basePackage 扫描包路径* @return com.google.common.base.Function<java.lang.Class<?>,java.lang.Boolean>* @version 1.0.0**/private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {return new Function<Class<?>, Boolean>() {@Overridepublic Boolean apply(Class<?> input) {for (String strPackage : basePackage.split(",")) {boolean isMatch = input.getPackage().getName().startsWith(strPackage);if (isMatch) {return true;}}return false;}};}/*** @methodName declaringClass* @description 将实例对象转为optional对象* @author zlt* @date 2018/10/29* @param input* @return com.google.common.base.Optional<? extends java.lang.Class<?>>* @version 1.0.0**/private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {return Optional.fromNullable(input.declaringClass());}
}

【SpringBoot】集成swagger相关推荐

[Swagger2]SpringBoot集成Swagger
SpringBoot集成Swagger 引入依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 ...
20190909 SpringBoot集成Swagger
SpringBoot集成Swagger 1. 引入依赖 // SpringBoot compile('org.springframework.boot:spring-boot-starter-web' ...
springboot集成swagger页面空白解决方法
今天在个人springboot项目使用swagger时遇到页面始终空白的问题,就顺便贴个博文,简单写下springboot集成swagger,并记录下问题. 1. 引入依赖包 <dependen ...
【水滴石穿】SpringBoot 集成Swagger
SpringBoot 集成Swagger Swagger 可以使你的restful接口自动生成接口文档,方便查看与测试,下面是一些具体步骤: 1.引入swagger相关依赖 <dependenc ...
Springboot集成Swagger
Springboot集成Swagger 1. Swagger概述 2. Swagger注解说明 3. Springboot集成Swagger 3.1 引入依赖 3.2 工具类 3.3 配置类 3.4 ...
SpringBoot集成swagger生成在线接口文档
SpringBoot集成swagger生成在线接口文档集成maven依赖 <dependency><groupId>io.springfox</groupId>& ...
springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
Springboot 集成Swagger在线调试
集成Swagger在线调试转载http://blog.battcn.com/2018/05/16/springboot/v2-config-swagger/ SpringBoot是为了简化Sprin ...
Springboot集成Swagger报错Parameter 0 of method linkDiscoverers in org.springframework.hateoas.config.Hat
第一次尝试使用springboot完成后端开发,在做demo的过程中集成swagger发生报错. 其中,swagger版本为2.2.2,springboot版本为2.3.4 觉得可能是版本不匹配,将s ...
SpringBoot——SpringBoot集成Swagger生成API文档
文章目录: 1.写在前面 2.步骤详解 2.1 pom文件中添加Swagger依赖 2.2 在application.properties核心配置文件中配置Swagger 2.3 编写需要生成API文 ...

【SpringBoot】集成swagger

【SpringBoot】集成swagger相关推荐

最新文章

热门文章