Swagger响应类型默认为void,除非ApiOperation.response()明确提供

时间:2014-07-17 07:41:25

标签: jersey jax-rs swagger

我有一个使用jersey的REST API应用程序(版本1.17)。 我试图使用swagger-maven-plugin(2.2版)设置swagger来记录相同的内容

Swagger文档建议:

  

在JAX-RS应用程序中,将自动使用该方法的返回类型,     除非它是{@code javax.ws.rs.core.Response}。在这种情况下,操作返回类型默认为void,因为无法知道实际的响应类型。

我使用自定义对象(不是javax.ws.rs.core.Response)作为我的方法返回类型。 但是响应类型仍然无效,除非我将其指定为ApiOperation注释的一部分。

@GET
@Produces({MediaType.APPLICATION_JSON})
@ApiOperation(
    value = "Description",
    response = MyCustomResponse.class
)
public MyCustomResponse myApiMethod() {
    return apiResponse;
}

我想从注释中删除响应值。 我在这里做错了什么?

0 个答案:

没有答案