我如何使用Spring Docs记录java.util.Map

Question

想象一下我下一堂课

public class MyDTO implements Serializable {
    private static final long serialVersionUID = 1L;

    private String id;
    private Map<String, String> names;

    // public Getters and Setters
}

当我使用下一个代码通过Spring对其进行记录时

private static FieldDescriptor[] myDTOFields() {
  return new FieldDescriptor[] { 
    fieldWithPath("id").description("id description"),
    fieldWithPath("names").description("Names description") };
}

它不起作用，并且出现错误。

org.springframework.restdocs.snippet.SnippetException：有效负载的以下部分未记录：

{
  "names" : {
    "en" : "test"
  }
}

那我怎么用spring docs记录java.util.Map？

谢谢 ：）

Answer 1

如文档中所述，您可以使用PayloadDocumentation.subsectionWithPath(“names”)它。这将意味着REST Docs会将names其包含的所有内容视为已被记录在案。