java - 许多方法的 Swagger ApiImplicitParams 注释

Question

我正在尝试用 swagger 来记录我的 API。身份验证是通过过滤器和 header 参数来处理的。所以我想使用 @ApiImplicitParams 来解释这一点，但不可能将注释放在类型上，所以我需要将它放在所有方法上......非常烦人!我在网上搜索过，但没有找到好的解决方案。

有人遇到同样的问题吗(我猜，因为我没有做非凡的事情)，你是如何实现的？可能有任何解决方案吗？

环境:jee6/jax-rs 2/Resteasy 3

Answer 1

您可以简单地在类级别声明参数:

public class PetResource {
  static PetData petData = new PetData();

  @ApiParam(value = "the authorization")
  @HeaderParam("my_auth")
  private String myAuth;

这将为类中的所有方法添加参数。