如何设置 Swagger 以忽略 @Asynchronous jax-rs bean 方法中的 @Suspended AsyncResponse? [英] How can I set Swagger to ignore @Suspended AsyncResponse in @Asynchronous jax-rs bean methods?

问题描述

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,...)
...

推荐答案

我认为你必须使用过滤器.这是一个示例 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.

这篇关于如何设置 Swagger 以忽略 @Asynchronous jax-rs bean 方法中的 @Suspended AsyncResponse?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！