许多方法的 Swagger ApiImplicitParams 注释

Posted 2023-03-06

【中文标题】许多方法的 Swagger ApiImplicitParams 注释

【英文标题】：Swagger ApiImplicitParams annotation for many methods

【发布时间】：2015-11-12 08:16:57

【问题描述】：

我正在尝试用 swagger 记录我的 API。身份验证由过滤器和标头参数处理。所以我想用@ApiImplicitParams 来解释这一点，但是不可能把注释放在类型上，所以我需要把它放在所有方法上......很烦人！我在互联网上搜索但找不到好的解决方案。

有没有人遇到过同样的问题（我猜，因为我没有做非凡的事情），你是怎么做到的？任何方面的解决方案都可能吗？

环境：jee6 / jax-rs 2 / resteasy 3

【参考方案1】：

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

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

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

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

【讨论】：

这就是我最终所做的，但我更喜欢带有方面的解决方案（我有另一个注释@Secured，两者将永远在一起）......

请向swagger-core 添加问题，以便@ApiImplicitParam 变量可以在类级别进行注释。这应该可以完成这项工作。