Как настроить Swagger на игнорирование @Suspended AsyncResponse в методах @Asynchronous jax-rs bean?

Question

Кажется, что Swagger-Core интерпретирует конечный элемент AsyncResponse asyncResponse @Suspended как параметр тела запроса. Это явно не предназначено, ни случай.

Я хотел бы сказать, что swagger-core должен игнорировать этот параметр и исключить его из api-docs. Есть идеи?

Вот как выглядит мой код:

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

Answer 1

Я думаю, что вы должны использовать фильтры. Вот пример https://github.com/wordnik/swagger-core/issues/269

Может быть закодировано в Java тоже.

Answer 2

Перенесемся в 2016, где swagger-springmvc заменен на springfox (документация доступна здесь). Игнорирование параметров доступно в springfox, но по какой-то причине не задокументировано:

Альтернатива 1: глобально игнорировать типы или аннотированные типы с .ignoredParameterTypes(...) в конфигурации Docket:

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .host(reverseProxyHost)
        .useDefaultResponseMessages(false)
        .directModelSubstitute(OffsetDateTime.class, String.class)
        .directModelSubstitute(Duration.class, String.class)
        .directModelSubstitute(LocalDate.class, String.class)
        .forCodeGeneration(true)
        .globalResponseMessage(RequestMethod.GET, newArrayList(
            new ResponseMessageBuilder()
                .code(200).message("Success").build()
            )
        .apiInfo(myApiInfo())
        .ignoredParameterTypes(AuthenticationPrincipal.class, Predicate.class, PathVariable.class)
        .select()
            .apis(withClassAnnotation(Api.class))
            .paths(any())
        .build();
}

Альтернатива 2: Использование @ApiIgnore-аннотация для игнорирования одного параметра в методе:

@ApiOperation(value = "User details")
@RequestMapping(value = "/api/user", method = GET, produces = APPLICATION_JSON_UTF8_VALUE)
public MyUser getUser(@ApiIgnore @AuthenticationPrincipal MyUser user) {
    ...
}

Answer 3

Я решил эту проблему с той же техникой, которую вы используете, но с другим подходом. Вместо того, чтобы помечать его как внутренний, я просто игнорирую все параметры с типом AsyncResponse, поэтому мне не нужно обновлять код во всех методах, чтобы добавить модификатор доступа.

public class CustomSwaggerSpecFilter implements SwaggerSpecFilter {
    @Override
    public boolean isOperationAllowed(Operation operation, ApiDescription api, Map<String, List<String>> params, Map<String, String> cookies,
            Map<String, List<String>> headers) {
        return true;
    }

    @Override
    public boolean isParamAllowed(Parameter parameter, Operation operation, ApiDescription api, Map<String, List<String>> params,
            Map<String, String> cookies, Map<String, List<String>> headers) {
        if(parameter.dataType().equals("AsyncResponse")) { // ignoring AsyncResponse parameters
            return false;
        }

        return true;
    }
}

Это работает лучше для меня.

Answer 4

Другим способом может быть сделать это.

@Bean
public SwaggerSpringMvcPlugin mvPluginOverride() {
    SwaggerSpringMvcPlugin swaggerSpringMvcPlugin = new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(apiInfo());
    swaggerSpringMvcPlugin.ignoredParameterTypes(PagedResourcesAssembler.class, Pageable.class);
    return swaggerSpringMvcPlugin;
}