Question

我使用Spring REST Docs来记录REST API。我正在尝试记录以下API操作：

GET /subsystems
GET /subsystems/some_name

例如，对GET /subsystems/samba的调用将返回以下JSON对象：

{ 
  "id": "samba", 
  "description": "..." 
}

您可以使用以下代码片段，该片段使用Spring REST Docs来记录此API操作：

this.mockMvc.perform(
    get("/subsystems/samba").accept(MediaType.APPLICATION_JSON))
    .andExpect(status().isOk()).andDo(
        document("subsystem").withResponseFields(
            fieldWithPath("id").description("Subsystem name"),
            fieldWithPath("description").description("Subsystem description")));

我的问题在于第一个操作：对GET /subsystems的调用返回一个JSON数组：

[ 
  { 
    "id" : "samba", 
    "description" : "..." 
  }, 
  { "id" : "ownCloud", 
    "description" : "..." 
  },
  { "id" : "ldap", 
    "description" : "..." 
  } 
]

我找不到任何显示如何在Spring REST Docs文档中记录此类结果的示例。我该怎么办？

Answer 1

使用Spring Rest Doc 1.0

完全可以实现这一点

this.mockMvc.perform(
    get("/subsystems").accept(MediaType.APPLICATION_JSON))
    .andExpect(status().isOk()).andDo(
        document("subsystem").withResponseFields(
            fieldWithPath("[].id").description("Subsystem name"),
            fieldWithPath("[].description").description("Subsystem description")));

要记录阵列本身，请使用

this.mockMvc.perform(
    get("/subsystems").accept(MediaType.APPLICATION_JSON))
    .andExpect(status().isOk()).andDo(
        document("subsystem").withResponseFields(
            fieldWithPath("[]").description("An array of subsystems"),
            fieldWithPath("[].id").ignore(),
            fieldWithPath("[].description").ignore()));

如果您只想记录数组本身，我忽略了其他两个字段。您也可以将两种解决方案结合起来。

享受。

编辑：我从Andy Wilkinson那里了解到，如果您记录顶级数组，则所有字段都标记为已记录。因此，如果您只想记录数组，可以安全地跳过忽略。

Answer 2

subsectionWithPath的

PayloadDocumentation方法也可以与[]一起使用，而不必忽略其余字段：

result.andDo(docHandler.document(
    responseFields(subsectionWithPath("[]").description("A list of objects")
)));

如何使用Spring REST Docs将顶级数组记录为响应有效负载

2 个答案: