[Error] The following parts of the payload were not documented

JUnitRestDocumentation와 mockmvc를 사용하여 controller 테스트 코드를 작성하는 중에 다음과 같은 error를 발견했습니다. 

 

org.springframework.restdocs.snippet.SnippetException: 
The following parts of the payload were not documented:
{
  "name" : "사이다"
}

 

error의 내용을 읽어보면 "name: 사이다" 부분이 문서화 되지 않아서 발생한 error 였습니다. 따라서 controller 테스트 코드에 해당 내용을 추가해주는 것으로 문제를 해결하였습니다.

 

error를 해결하는 도중에 requestFields를 사용하여 테스트 코드를 작성할 때에는 mocking 오브젝트의 content에 들어가는 내용을 모두 문서화해줘야 한다는 것을 알았습니다.

 

물론 다른 함수를 사용하여 content에 들어가는 값을 문서화를 진행하지 않도록 할 수도 있습니다만 테스트를 작성하는 이유와 문서화를 통한 다른 직군과의 협업을 생각하면 content 부분의 부분적인 문서화는 문제가 될 수도 있을 것 같아 모든 content를 문서화하는 것이 좋은 것 같습니다.