如何设置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的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));
    }
}

---

更新：基于答案的解决方案

---

Update: Solution based on Answer

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());

---

修改示例代码片段

---

Revised Example Code Fragment

...
@Asynchronous
public void makeCoffee( @Suspended @ApiParam(access = "internal") final AsyncResponse asyncResponse,...)
...

推荐答案

我想你必须使用过滤器。
以下是 https://github.com/wordnik/swaggercore的示例/ 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屋！