在swagger UI中发送动态自定义标头试用

时间:2014-11-04 18:37:13

标签: java swagger swagger-ui

我在java中使用swagger。

我正在通过代码中的requestAttributes读取名为callerId的标头。我没有通过注释@HeaderParam使用标题。

由于这个原因,标题部分没有显示在试图的swagger UI中。

如何在试用表单中显示此标题。

如果不对标头值进行硬编码,我有什么方法可以实现这一点。

提前致谢。

1 个答案:

答案 0 :(得分:15)

您可以使用@ApiImplicitParams和@ApiImplicitParam为操作添加参数。

以下维基文档应该为您提供有关如何使用这些注释的说明 - https://github.com/swagger-api/swagger-core/wiki/Annotations#apiimplicitparam-apiimplicitparams

请记住,我在此假设这不是安全标头,但实际上是API的一部分(至少基于您给出的描述)。如果您正在寻找安全标头,那么还有一种替代方法。请留言,我会编辑此回复。