私は春のドキュメントを使用してjava.util.Mapを文書化する可能性がどのように

Question

私は春

でそれを文書化するために、次のコードを使用する場合

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

それは動作しません

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

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

    // public Getters and Setters 
} 

私は次のクラスを持っている想像してみて私はエラーが発生します。

org.springframework.restdocs.snippet.SnippetException：ペイロードの次 部分は記載されませんでした。

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

それでは、どのように私は春のドキュメントでjava.util.Mapを文書化するだろうか？

感謝:)

Answer 1

described in the documentationとして、あなたはこのためPayloadDocumentation.subsectionWithPath(“names”)を使用することができます。これは、REST Docsがnamesと、それに含まれているすべてが文書化されているとみなすことを意味します。