Swagger2怎么免密登录
时间: 2024-02-12 21:41:34 浏览: 64
Swagger2提供了多种方式进行身份认证,其中一种是通过在HTTP请求中添加Authorization头信息实现免密登录。
具体步骤如下:
1. 配置Swagger2
在Docket的构建方法中添加以下代码:
```
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.securitySchemes(securitySchemes())
.securityContexts(securityContexts())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
private List<ApiKey> securitySchemes() {
List<ApiKey> apiKeyList= new ArrayList<>();
apiKeyList.add(new ApiKey("token", "token", "header"));
return apiKeyList;
}
private List<SecurityContext> securityContexts() {
List<SecurityContext> securityContexts = new ArrayList<>();
securityContexts.add(
SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("^(?!auth).*$"))
.build());
return securityContexts;
}
List<SecurityReference> defaultAuth() {
AuthorizationScope[] authorizationScopes = new AuthorizationScope[0];
return Arrays.asList(new SecurityReference("token", authorizationScopes));
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("更多Spring Boot相关文章请关注:https://www.csdn.net/")
.termsOfServiceUrl("https://www.csdn.net/")
.contact("csdn")
.version("1.0")
.build();
}
```
其中,securitySchemes()方法用于配置安全认证方式,这里使用的是API Key方式。securityContexts()方法用于配置安全上下文,指定哪些接口需要进行认证。defaultAuth()方法用于设置默认的认证方式。
2. 添加Token拦截器
在Spring Boot应用程序中添加一个Token拦截器,用于从HTTP请求中获取Authorization头信息,并进行身份认证。
```
public class TokenInterceptor implements HandlerInterceptor {
private static final Logger LOGGER = LoggerFactory.getLogger(TokenInterceptor.class);
private static final String TOKEN_HEADER = "token";
private static final String TOKEN_SECRET = "123456";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String token = request.getHeader(TOKEN_HEADER);
if (StringUtils.isBlank(token) || !token.equals(TOKEN_SECRET)) {
LOGGER.error("Token is invalid or not provided!");
response.setStatus(HttpStatus.UNAUTHORIZED.value());
return false;
}
return true;
}
}
```
其中,TOKEN_SECRET为自定义的密钥,可以设置为任意字符串。
3. 配置拦截器
在WebMvcConfigurerAdapter配置类中添加TokenInterceptor拦截器。
```
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
@Bean
public TokenInterceptor getTokenInterceptor() {
return new TokenInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(getTokenInterceptor())
.addPathPatterns("/**");
super.addInterceptors(registry);
}
}
```
4. 测试免密登录
启动Spring Boot应用程序,然后在浏览器中访问http://localhost:8080/swagger-ui.html。在右上角的Authorize按钮中输入token {TOKEN_SECRET},然后点击Authorize按钮即可进行免密登录。
希望以上步骤能够帮助你成功实现Swagger2的免密登录,如有疑问请继续提问。
阅读全文