前言:
集成swagger到已进行interceptor配置的spring boot项目中;
解决问题:
1.swagger配置
2.interceptor不对swagger进行拦截
配置swagger
首先,在pom文件中引入依赖:
<properties>
<io.springfox.version>2.9.2</io.springfox.version>
</properties>
<dependencies>
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${io.springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${io.springfox.version}</version>
</dependency>
</dependencies>
而后,新建SwaggerConfig.java类:
package pers.tong.demo.guest.config;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.service.Contact;
/**
* 〈config for swagger〉
*
* @author 2tong
* @create 2020/3/18
* @since 1.0.0
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("pers.tong.demo.guest.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("demo")
.description("demo API 1.0 操作文档")
.version("1.0")
.contact(new Contact("2tong杂货铺", "url", "mail"))
.build();
}
}
而后,针对inteceptor修改相关配置:
## properties文件进行配置
noAuthUrls=/swagger-ui.html,/swagger-resources/**,/error,/webjars/**
/***
* 添加拦截器
*
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(loginInterceptor).addPathPatterns("/**").
excludePathPatterns(applicationProperty.getNoAuthUrls());
}
为接口配置swagger支持
package pers.tong.demo.guest.controller;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import pers.tong.demo.guest.config.ApplicationProperty;
import pers.tong.demo.guest.dto.LoginDTO;
import pers.tong.demo.guest.dto.ModifyPasswordDTO;
import pers.tong.demo.guest.dto.RegisterDTO;
import pers.tong.demo.guest.po.User;
import pers.tong.demo.guest.service.UserService;
import pers.tong.demo.guest.util.redis.RedisOperator;
import pers.tong.demo.guest.vo.LoginVO;
import pers.tong.demo.guest.vo.UserVO;
import pers.tong.demo.guest.vo.result.FailResponse;
import pers.tong.demo.guest.vo.result.Response;
import pers.tong.demo.guest.vo.result.SuccessResponse;
import javax.servlet.http.HttpServletRequest;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
@Api(value = "用户", description = "用户操作 API", position = 100, protocols = "http")
@RestController
@RequestMapping("/guest")
public class UserController {
@Autowired
private UserService userService;
@Autowired
private RedisOperator redisOperator;
@Autowired
private ApplicationProperty applicationProperty;
private Logger logger = LoggerFactory.getLogger(this.getClass());
@ApiOperation(
value = "用户注册",
notes = "根据参数创建用户"
)
@PostMapping("/register")
public Response register(@Valid RegisterDTO registerDTO){
boolean result = userService.register(registerDTO);
if(result){
return new SuccessResponse<>();
}
else{
return new FailResponse();
}
}
}
访问页面
默认访问 http://localhost:8080/swagger-ui.html