java - 自定义 API 响应中的 JSON 属性

Question

这个问题已经有答案了:

How to map JSON field names to different object field names? (5 个回答)

已关闭 5 年前。

我正在使用 Spring Boot、Jersey 和 Swagger (io.swagger:swagger-jersey2-jaxrs:1.5.8)

我有一个 JSON 响应作为对 GET 的响应返回，假设它是这样的:

{"myText": "success"}

但是，我希望能够自定义响应中的属性，使其与其底层的 java 表示不同，例如

{"My Own Text": "success"}

我无法使用“My Own Text”作为 Java 类属性，因此我将其存储为 myText，但我想以更“友好”的格式将其公开给客户端。我尝试过使用 ApiModelProperty(name="My Own Text") 。这会更改 Swagger 文档中显示的模型，但响应仍然返回为“myText”。

我也想对 PUT 做类似的事情。解决方案是否提供另一种服务来执行不友好属性到友好属性的字典映射？

Answer 1

您应该使用JsonProperty在 myText 的 getter 上:

  @JsonProperty("My Own Text")

used to indicate external property name,