设置 Swagger 以忽略 @Asynchronous jax-rs bean 方法的 @Suspended AsyncResponse?
it1352
帮助1人
问题说明
Swagger-Core 似乎将 @Suspended final AsyncResponse asyncResponse 成员解释为请求正文参数.这显然不是故意的,也不是事实.
Swagger-Core seems to interpret the @Suspended final AsyncResponse asyncResponse member as request body param. This is clearly not intended nor the case.
我想告诉 swagger-core 忽略此参数并将其从 api-docs 中排除.有什么想法吗?
I would like to tell swagger-core to ignore this parameter and to exclude it from the api-docs. Any ideas?
这是我的代码的样子:
@Stateless
@Path("/coffee")
@Api(value = "/coffee", description = "The coffee service.")
public class CoffeeService
{
@Inject
Event<CoffeeRequest> coffeeRequestListeners;
@GET
@ApiOperation(value = "Get Coffee.", notes = "Get tasty coffee.")
@ApiResponses({
@ApiResponse(code = 200, message = "OK"),
@ApiResponse(code = 404, message = "Beans not found."),
@ApiResponse(code = 500, message = "Something exceptional happend.")})
@Produces("application/json")
@Asynchronous
public void makeCoffee( @Suspended final AsyncResponse asyncResponse,
@ApiParam(value = "The coffee type.", required = true)
@QueryParam("type")
String type)
{
coffeeRequestListeners.fire(new CoffeeRequest(type, asyncResponse));
}
}
<小时>
更新:基于答案的解决方案
public class InternalSwaggerFilter implements SwaggerSpecFilter
{
@Override
public boolean isOperationAllowed(Operation operation, ApiDescription apiDescription, Map<String, List<String>> stringListMap, Map<String, String> stringStringMap, Map<String, List<String>> stringListMap2) {
return true;
}
@Override
public boolean isParamAllowed(Parameter parameter, Operation operation, ApiDescription apiDescription, Map<String, List<String>> stringListMap, Map<String, String> stringStringMap, Map<String, List<String>> stringListMap2) {
if( parameter.paramAccess().isDefined() && parameter.paramAccess().get().equals("internal") )
return false;
return true;
}
}
<小时>
FilterFactory.setFilter(new InternalSwaggerFilter());
<小时>
修改示例代码片段
...
@Asynchronous
public void makeCoffee( @Suspended @ApiParam(access = "internal") final AsyncResponse asyncResponse,...)
...
正确答案
#1
我认为你必须使用过滤器.这是一个示例 https://github.com/wordnik/swagger-core/issues/269
I think you have to use filters. Here is an example https://github.com/wordnik/swagger-core/issues/269
也可以用 java 编码.
Could be coded in java too.
这篇好文章是转载于:学新通技术网
- 版权申明: 本站部分内容来自互联网,仅供学习及演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,请提供相关证据及您的身份证明,我们将在收到邮件后48小时内删除。
- 本站站名: 学新通技术网
- 本文地址: /reply/detail/tanhcgabbk
系列文章
更多
同类精品
更多
-
YouTube API 不能在 iOS (iPhone/iPad) 工作,但在桌面浏览器工作正常?
it1352 07-30 -
iPhone,一张图像叠加到另一张图像上以创建要保存的新图像?(水印)
it1352 07-17 -
保持在后台运行的 iPhone 应用程序完全可操作
it1352 07-25 -
使用 iPhone 进行移动设备管理
it1352 07-23 -
在android同时打开手电筒和前置摄像头
it1352 09-28 -
扫描 NFC 标签时是否可以启动应用程序?
it1352 08-02 -
检查邮件是否发送成功
it1352 07-25 -
Android微调工具-删除当前选择
it1352 06-20 -
希伯来语的空格句子标记化错误
it1352 06-22 -
Android App 和三星 Galaxy S4 不兼容
it1352 07-20