java - Swagger:使用 JAX-RS Map 作为主体参数

Question

我正在尝试在现有的 JAX-RS REST 项目中设置 Swagger 来记录我们的 API。

在我们接受 JSON 请求正文的操作中，我们一直使用这个习惯用法:

@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value="Some operation")
@ApiImplicitParams(value={
        @ApiImplicitParam(name="val1", value="Input 1", dataType="string", paramType="body"),
        @ApiImplicitParam(name="val2", value="Input 2", dataType="string", paramType="body")
})
public Response login(Map<String, Object> request) { }

通过接受 Map，JAX-RS 将 JSON 对象映射到映射中，以按键名称访问值。这很好，并且避免了每个此类操作都需要一个模型。

但是，Swagger 会扫描此类操作并自动包含 Map 作为请求参数。我的意图是在 @ApiImplicitParams 注释中正确定义参数。有没有办法让 Swagger 忽略 Map 并只使用 @ApiImplicitParams 中定义的参数？

Answer 1

我遇到了同样的问题并使用了

public Response login(@Context Map<String, Object> request) { }

这实际上隐藏了输出中的实际参数。注解来自

javax.ws.rs.core