Dropwizard/Jersey 将 Java 列表返回为没有根节点的 JSON

Question

我正在使用 dropwizard，它使用 jersey 和 jackson 作为 json。我的问题是当我返回一个列表时它没有指定根。

我有一个 POJO 类：

public class Company { 
public String id; 
public String name; 
public String address; 
}

我的资源是这样设置的：

@GET
@Path("/companies/all")
public List<Company> getAllCompanies(){
    ...
    return companies;
}

我得到以下回复：

[{
"id": "01",
"name": "Yammer Corp",
"address": "1 Finite Loop"
},
{
"id": "02",
"name": "DropWizards Inc",
"address": "4 Magic Square, Olympus"
}]

虽然我想要的是如下所示：

{"Companies" : 
[{
"id": "01",
"name": "Yammer Corp",
"address": "1 Finite Loop"
},
{
"id": "02",
"name": "DropWizards Inc",
"address": "4 Magic Square, Olympus"
}
]}

有什么想法吗？提前致谢。

Answer 1

您需要再创建一个包装List<Company> 的POJO

public class ApiResponse
{
   private List<Company> Companies;
   //Getter and Setter
   //Public Constructor
}

您的 GET 方法所需的更改是：

@GET
@Path("/companies/all")
public ApiResponse getAllCompanies(){
    //Set your ApiResponse Object with the companies List.
    ApiResponse apiResponse = new ApiResponse(companies);
    return apiResponse;
}

Answer 2

我相信您可以使用 Jackson API 进行自定义。这是一种允许您使用 ObjectWriter 设置生成 JSON 的根的方法。

    @GET
    @Path("/companies/all")
    public Response getAllCompanies() throws JsonProcessingException {
        List<Company> companies = Lists.newArrayList();
        Company yc = new Company();
        yc.id = "01";
        yc.name = "Yammer Corp";
        yc.address = "1 Finite Loop";
        companies.add(yc);
        Company dw = new Company();
        dw.id = "02";
        dw.name = "DrowWizards Inc";
        dw.address = "4 Magic Square, Olympus";
        companies.add(dw);

        ObjectMapper objectMapper = new ObjectMapper();
        ObjectWriter writer = objectMapper.writer();
        String entity = writer.withRootName("Companies").writeValueAsString(companies);
        return Response.ok(entity).build();
    }

Answer 3

如果您查看您要求返回公司列表的代码：

public List<Company> getAllCompanies(){

如果你想返回一个带有 Companies 值的 JSON 对象，那么你需要一个与之匹配的合适的 Java 对象。

public class MyListOfCompanies {
  List<Companies> companies;
}

然后你会要求你的代码返回它：

public MyListOfCompanies getAllCompanies(){

但是，如果您真的想这样做，请考虑一下。如果您考虑某人为您的 API 进行编码的情况，他们是否更愿意收到公司列表（正如他们所要求的并且 API 暗示他们将获得），或者除了包含公司列表之外没有其他用途的对象?

最后，对于良好的 REST 设计，获取所有公司列表的常用方法是使用路径 /companies，而不是 /companies/all。