1

我正在为返回如下对象的 REST 服务做文档：

Map<String, HashMap<Long, String>>

而且我找不到描述此类对象的响应字段的方法。

让我们看看我的代码。

服务：

@RequestMapping(value = "/data", method = RequestMethod.GET)
public Map<String, HashMap<Long, String>> getData()
 {
Map<String, HashMap<Long, String>> list = dao.getData();
return list;
}

我的基于单元测试的文档：

  @Test
  public void testData() throws Exception
  {
    TestUtils.beginTestLog(log, "testData");

    RestDocumentationResultHandler document = document(SNIPPET_NAME_PATTERN ,preprocessResponse(prettyPrint()));    
    document.snippets(
 //        ,responseFields(
 //            fieldWithPath("key").description("key description").type("String"),
 //            fieldWithPath("value").description("value as a Hashmap").type("String"),
 //            fieldWithPath("value.key").description("value.key description").type("String"),
 //            fieldWithPath("value.value").description("value.value description").type("String"),
 //        )

      String token = TestUtils.performLogin(mockMvc, "user", "password");

    mockMvc
    .perform(get(APP_BUILD_NAME + "/svc/data").contextPath(APP_BUILD_NAME)
        .header("TOKEN", token)
    )
    .andExpect(status().is(200))
    .andExpect(content().contentType("application/json;charset=UTF-8"))
    .andExpect(jsonPath("$").isMap())
    .andDo(document);

    TestUtils.endTestLog(log, "testData");
 }

如您所见，响应字段的代码已被注释掉，因为我还没有任何解决方案。我正在努力，但我非常感谢你的帮助。先感谢您。

4

2 回答 2

3
于 2016-05-25T12:12:18.600 回答
0

有两种选择：

1> 将 MAP 更改为对象列表，以便可以轻松描述响应字段。

2> 手动将描述放入 index.adoc 文件。

就我而言，我选择选项 2，因为我必须坚持使用 MAP。

于 2016-06-01T11:06:03.263 回答