java – 为bearer auth添加一个swagger注释

前端之家收集整理的这篇文章主要介绍了java – 为bearer auth添加一个swagger注释前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

我正在开发一个dropwizard REST服务.
我使用https://bitbucket.org/b_c/jose4j/wiki/Home为jwt添加了身份验证

令牌必须进入Authorization标头

Authorization: Bearer [TOKEN]

我想找到一个很好的方法添加一些swagger注释,以便在swagger-ui上拥有授权标头.

我找到了一个解决方法,隐藏了身份验证参数并使用@HeaderParam添加了一个虚拟参数

@POST
@Path("/test/")
public Foo postBar(
        @Auth @ApiParam(hidden = true) Principal user,@ApiParam("data") Foo bar,@HeaderParam(value="Authorization")String dummy)

这将添加到参数中:

{
  "name" : "Authorization","in" : "header","required" : false,"type" : "string"
} 

如果我将@HeadParam用于Principal用户,我会得到运行时间:

Caused by: org.glassfish.jersey.server.model.ModelValidationException: Validation of the application resource model has Failed during application initialization.

[[FATAL] No injection source found for a parameter of type public java.util.Map com.foo.bar.AppResource.get(java.security.Principal) at index 0.; source='ResourceMethod{httpMethod=GET,consumedTypes=[],producedTypes=[application/json],suspended=false,suspendTimeout=0,suspendTimeoutUnit=MILLISECONDS,invocable=Invocable{handler=ClassBasedMethodHandler{handlerClass=class com.mykronoz.data.tracking.resources.AppResource,handlerConstructors=[org.glassfish.jersey.server.model.HandlerConstructor@6374d682]},definitionMethod=public java.util.Map com.foo.bar.AppResource.get(java.security.Principal),parameters=[Parameter [type=interface java.security.Principal,source=Authorization,defaultValue=null]],responseType=java.util.Map

有没有更好的方法呢?

最佳答案
如果添加一个swaggerdefinition

@SwaggerDefinition(
  securityDefinition = @SecurityDefinition(
    apiKeyAuthDefinitions = {
      @ApiKeyAuthDefinition(key = "user",name = "Authorization",in = ApiKeyLocation.HEADER)
    }
  )
)

然后,您将可以访问swagger ui的“授权”功能.将“Bearer XXX ….”字符串添加为API密钥应该会导致调用端点,并按照您希望的方式设置Authorize标头,并将用户字段设置为其值.

警告:我还没有看到这个端到端的工作,因为我遇到了令牌本身的问题,但似乎我得到了正确的事情.

原文链接:https://www.f2er.com/java/437288.html

猜你在找的Java相关文章