Spring REST 文檔 - 避免記錄鏈接

Question

我在 SpringBoot 2 應用程序中有這個方法：

@Test
public void shouldEchoTheParameter() throws Exception {
mockMvc.perform(get("/echo").param("echoMessage", "Test"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.message", is("Test")))
.andDo(document("echo-example",
preprocessResponse(prettyPrint()),
links(linkWithRel("self").ignored().optional()),
requestParameters(
parameterWithName("echoMessage").description("The message to be echoed")),
responseFields(
fieldWithPath("message").
description("The message echoed"))
));
}

我想避免記錄這部分有效負載：

{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/echo"
    }
  }
}

我包括了這個：

links(linkWithRel("self").ignored().optional()),

但我有這個錯誤：

java.lang.IllegalStateException: No LinkExtractor has been provided and one is not available for the content type application/vnd.pxs.echo.v1+json;charset=UTF-8

Answer 1

links(…)創建一個專門用於記錄超媒體鏈接的片段。 由於您根本不想記錄任何鏈接，因此應避免使用links片段。

相反，修改您對responseFields的使用以忽略_links字段及其下嵌套的所有內容。 REST Docs 將此稱為一個小節，可以使用subsectionWithPath(String)進行記錄。 你想忽略_links小節，所以你會做這樣的事情：

responseFields(subsectionWithPath("_links").ignored(),     
    fieldWithPath("message").description("The message echoed"))