我正在使用Spring Boot来构建REST API . 我添加了Swagger-ui来处理文档 . 我遇到问题将客户端身份验证流程实现为swagger,问题是我可以通过基本身份验证来获取swagger-ui来授权提供的客户端ID(用户名)和客户端密码(密码),但是swagger UI不会似乎然后将结果访问令牌应用于 endpoints 调用 .
确认,我的授权程序; - 使用基本身份验证将base64编码的用户名/密码和grant_type = client_credentials发送到/ oauth / token . Spring返回一个access_token - 在将来的API调用中,使用提供的access_token作为承载令牌
我认为问题可能是因为我需要在我的控制器中的每个方法上放置一些东西来告诉swagger endpoints 需要身份验证和类型,但我找不到任何关于如何执行此操作的明确文档,我不知道知道我是否需要对我的swagger配置进行任何进一步的更改 .
这是一个控制器的示例(删除大多数方法以减小大小);
@Api(value="Currencies", description="Retrieve, create, update and delete currencies", tags = "Currencies")
@RestController
@RequestMapping("/currency")
public class CurrencyController {
private CurrencyService currencyService;
public CurrencyController(@Autowired CurrencyService currencyService) {
this.currencyService = currencyService;
}
/**
* Deletes the requested currency
* @param currencyId the Id of the currency to delete
* @return 200 OK if delete successful
*/
@ApiOperation(value = "Deletes a currency item", response = ResponseEntity.class)
@RequestMapping(value="/{currencyId}", method=RequestMethod.DELETE)
public ResponseEntity<?> deleteCurrency(@PathVariable("currencyId") Long currencyId) {
try {
currencyService.deleteCurrencyById(currencyId);
} catch (EntityNotFoundException e) {
return new ErrorResponse("Unable to delete, currency with Id " + currencyId + " not found!").response(HttpStatus.NOT_FOUND);
}
return new ResponseEntity(HttpStatus.OK);
}
/**
* Returns a single currency by it's Id
* @param currencyId the currency Id to return
* @return the found currency item or an error
*/
@ApiOperation(value = "Returns a currency item", response = CurrencyResponse.class)
@RequestMapping(value="/{currencyId}", method = RequestMethod.GET, produces = "application/json")
public ResponseEntity<RestResponse> getCurrency(@PathVariable("currencyId") Long currencyId) {
Currency currency = null;
try {
currency = currencyService.findById(currencyId);
} catch (EntityNotFoundException e) {
return new ErrorResponse("Currency with Id " + currencyId + " could not be found!").response(HttpStatus.NOT_FOUND);
}
return new CurrencyResponse(currency).response(HttpStatus.OK);
}
/**
* Returns a list of all currencies available in the system
* @return Rest response of all currencies
*/
@ApiOperation(value = "Returns a list of all currencies ordered by priority", response = CurrencyListResponse.class)
@RequestMapping(value="", method=RequestMethod.GET, produces="application/json")
public ResponseEntity<RestResponse> getCurrencies() {
return new CurrencyListResponse(currencyService.getAllCurrencies()).response(HttpStatus.OK);
}
}
这是我目前的招摇配置;
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
@Bean
public SecurityConfiguration security() {
return SecurityConfigurationBuilder.builder()
.clientId("12345")
.clientSecret("12345")
.scopeSeparator(" ")
.useBasicAuthenticationWithAccessCodeGrant(true)
.build();
}
@Bean
public Docket productApi() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.xompare.moo.controllers"))
.build()
.securitySchemes(Arrays.asList(securityScheme()))
.securityContexts(Arrays.asList(securityContext()))
.apiInfo(metaData());
}
private SecurityContext securityContext() {
return SecurityContext.builder()
.securityReferences(Arrays.asList(new SecurityReference("spring_oauth", scopes())))
.forPaths(PathSelectors.regex("/.*"))
.build();
}
private AuthorizationScope[] scopes() {
AuthorizationScope[] scopes = {
new AuthorizationScope("read", "for read operations"),
new AuthorizationScope("write", "for write operations") };
return scopes;
}
public SecurityScheme securityScheme() {
GrantType grantType = new ClientCredentialsGrant("http://localhost:8080/oauth/token");
SecurityScheme oauth = new OAuthBuilder().name("spring_oauth")
.grantTypes(Arrays.asList(grantType))
.scopes(Arrays.asList(scopes()))
.build();
return oauth;
}
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
通过spring进行身份验证在这一点上完美运行,我唯一的问题是让它与Swagger UI一起工作 .
2 回答
我在阅读了这个链接的内容之后,通过从swagger-ui版本2.8.0恢复到2.7.0来解决这个问题,这个内容暗示它是版本2.8.0的问题
https://github.com/springfox/springfox/issues/1961
我认为您需要在密钥前添加"Bearer ",就像在此帖子中显示的那样:Spring Boot & Swagger UI. Set JWT token