2017-11-20 8 views
1

내가 봄내가 봄 워드 프로세서를 사용하여 java.util.Map을 문서화 수있는 방법

그것을 문서화하는 다음 코드를 사용하는 경우
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을 문서화 수 있을까?

감사합니다 :)

답변

2

described in the documentation, 당신이에 대한 PayloadDocumentation.subsectionWithPath(“names”)을 사용할 수 있습니다. REST Docs는 names 및 문서에 포함 된 모든 내용을 고려해야합니다.