在Swagger中记录Map的可能值

Question

我有一个JAX-RS方法，它采用Map来促进部分更新。

   @POST
   @Consumes(MediaType.APPLICATION_JSON)
   @Produces(MediaType.APPLICATION_JSON)
   @Path("/{id}/edit")
   public Response edit(HashMap<String, Object> data)

我不能使用补丁，说来话长。我需要记录客户端可以发送哪些参数，以便他们可以在昂首阔步的UI中看到它们。一种方法是使用@ApiInplityParam

@ApiImplicitParams({
    @ApiImplicitParam(name = "payload", value = "payload", required = true, dataType = "com.me.PartialUpdatePerson", paramType = "body"),
})

这是一个不错的工作。PartialUpdatePerson是一个包含允许发送的各种参数的类。

问题是在swagger UI中，它仍然用地图显示我的身体。样本值为:

{
  "additionalProp1": {},
  "additionalProp2": {},
  "additionalProp3": {}
}

以及有效载荷。

有没有，我可以告诉炫耀，不显示这个？即从文档的角度忽略HashMap数据？我没有使用Spring，所以@ApiIgnore是不可能的。

谢谢

Answer 1

public Response edit(@ApiParam(hidden = true) HashMap<String, Object> data)