使用Resteasy炫耀securityDefinition
使用Resteasy炫耀securityDefinition
提问于 2017-05-03 20:31:56
我使用Application子类和beanConfig对象配置了swagger，我的securityDefinition必须允许swagger ui显示de api_key字段，以允许对所有服务层进行身份验证。
BeanConfig beanConfig = new BeanConfig();
beanConfig.setSchemes(new String[] { "http" });
beanConfig.setHost("192.168.4.9:8080");
beanConfig.setBasePath("/cjppa/rest");
beanConfig.setResourcePackage("com.cjppa.fpuna.backend.resources");
beanConfig.setScan(true);
beanConfig.setPrettyPrint(true);
io.swagger.models.Info info = new io.swagger.models.Info();
io.swagger.models.Contact contact = new io.swagger.models.Contact();
info.setVersion("1.0");
beanConfig.setInfo(info);
io.swagger.models.auth.ApiKeyAuthDefinition apikey = new
io.swagger.models.auth.ApiKeyAuthDefinition();
apikey.setName("x-token");
apikey.setIn(In.HEADER);
Swagger swagger = new Swagger().info(info);
swagger.securityDefinition("api_key", apikey);
beanConfig.configure(swagger);预期的令牌位于“x- api_key”http头中。
回答 2
Stack Overflow用户
发布于 2018-03-21 21:06:34
我还尝试将swagger引入到我的resteasy for服务中，使用BasicAuthentification来执行for服务的一些操作。我在pom.xml中通过maven导入了swagger：
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-jaxrs</artifactId>
<version>1.5.18</version>
</dependency>在我的Application类中，我配置了BeanConfig：
import javax.ws.rs.ApplicationPath;
import io.swagger.jaxrs.config.BeanConfig;
@ApplicationPath("/rest")
public class Application extends javax.ws.rs.core.Application{
public Application() {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setVersion("1.0");
beanConfig.setResourcePackage("de.mycompany.topic.ws");
beanConfig.setBasePath("/de.mycompany.topic.ws/rest/");
beanConfig.setScan(true);
}
}重要的是通过注释在ReaderListener实现中配置BasicAuthentification。basicAuth是一个任意的名称。
import io.swagger.annotations.BasicAuthDefinition;
import io.swagger.annotations.SecurityDefinition;
import io.swagger.annotations.SwaggerDefinition;
import io.swagger.jaxrs.Reader;
import io.swagger.jaxrs.config.ReaderListener;
import io.swagger.models.Swagger;
@SwaggerDefinition(securityDefinition = @SecurityDefinition(basicAuthDefinitions = {
@BasicAuthDefinition(key = "basicAuth")
}) )
public class SwaggerCustomizeDefinition implements ReaderListener {
@Override
public void beforeScan(Reader reader, Swagger swagger) {
}
@Override
public void afterScan(Reader reader, Swagger swagger) {
}
}在MyRestService中，我注释了在没有基本身份验证的情况下不能使用的操作。例如，为了拯救客户，请参阅此处：
@Api
@Path("/")
public class MyRestService {
private final static String UTF8 = ";charset=UTF-8";
@POST
@Path("/customer")
@Produces(MediaType.APPLICATION_JSON + UTF8)
@ApiOperation(
value = "Saves customer specified in the body",
notes = "note that appears in swagger ui",
authorizations = {
@Authorization(value = "basicAuth", scopes={})
})
@ApiResponses(value = {
@ApiResponse(code = 201, message = "customer created"),
@ApiResponse(code = 401, message = "Unauthorized"),
@ApiResponse(code = 404, message = "customer format not supported"),
})
public Response saveCustomer(
String content,
@BasicAuthDefinition(key = "basicAuth") @HeaderParam("Authorization") String authorization) {
// authorization
try {
if (!MyManager.isAuthorized(authorization)) {
return Response.status(Status.UNAUTHORIZED).build();
}
} catch (Exception e) {
return Response.status(Status.INTERNAL_SERVER_ERROR).build();
}
//do the work, authorization was ok
}
}就这样。我尝试了很多变体，这是唯一一个对我整体有效的变体。我的主要问题是，授权按钮没有出现在ui中，swagger ui中单个方法上方的锁也无法单击，因此基本身份验证模式对话框不会出现。在这个实现中，它是有效的。
Stack Overflow用户
发布于 2017-07-04 13:47:42
您可以在afterScan方法中实现io.swagger.jaxrs.config.ReaderListener、addSecurity。例如：
@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = {
@ApiKeyAuthDefinition(in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = "token", name = "E-token"),
@ApiKeyAuthDefinition(in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = "userId", name = "E-userId"),
@ApiKeyAuthDefinition(in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = "corpId", name = "E-corpId") }) )
public class SwaggerCustomizeDefinition implements ReaderListener {
@Override
public void beforeScan(Reader reader, Swagger swagger) {
}
@Override
public void afterScan(Reader reader, Swagger swagger) {
swagger.addSecurity(new SecurityRequirement().requirement("token"));
swagger.addSecurity(new SecurityRequirement().requirement("userId"));
swagger.addSecurity(new SecurityRequirement().requirement("corpId"));
}
}页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/43760128
复制相关文章
相似问题
腾讯云开发者
