为bearer auth添加一个swagger注释

时间:2016-04-03 19:53:08

标签: java swagger jwt dropwizard swagger-ui

我正在开发一个dropwizard REST服务。 我使用https://bitbucket.org/b_c/jose4j/wiki/Home

为jwt添加了身份验证

令牌必须进入授权标题

Authorization: Bearer [TOKEN]

我想找到添加一些招摇注释的好方法,以便在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 user我的运行时间:

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<java.lang.String, java.lang.Object>}, nameBindings=[]}']

有更好的方法吗?

1 个答案:

答案 0 :(得分:3)

如果你添加一个swaggerdefinition

@SwaggerDefinition(
  securityDefinition = @SecurityDefinition(
    apiKeyAuthDefinitions = {
      @ApiKeyAuthDefinition(key = "user", name = "Authorization", in = ApiKeyLocation.HEADER)
    }
  )
)
然后,您就可以访问“授权”&#39;昂首阔步的特征。添加你的&#34; Bearer XXX ....&#34;然后,作为API密钥的字符串应该调用端点,并按照您希望的方式设置Authorize标头,并将用户字段设置为其值。

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