在REST API响应中更改字段名称

Question

Hi I'm a newbie so I may not understand high level solutions !

So coming to the point I want to send a response for a REST API. So what basically happening is that I'm returning an object from a method and then the fields of those objects along with their corresponding values get displayed in the API response.

To be clear lets say we have a class defined as

Class Sample
{
    String fruit;
    int cost;
}

Now lets say we have an object of the above class (Sample abc). Also we have a method as below:

@RequestMapping(/inventory)
public Sample getInventory()
{
    Sample abc = new Sample();
    ----Some processing----
    return abc;
}

So the response I'm getting is that

{
    "fruit":"apple",
    "cost":100
}

Now what I want is "fruit.name" in the response, but obviously I can't have a field with that name(having dot or @ characters) !

{
    "fruit.name":"apple",
    "cost@Dollars":100
}

So is there any way with the help of which I can get this kind of response ?

Answer 1

If you're using Jackson you could use @JsonProperty

public class Sample {
  @JsonProperty("fruit.name")
  public String fruit;
  @JsonProperty("cost@Dollars")
  public int cost; 
}