스프링 REST Docs 만들기


스프링 REST Docs 만들기

프로젝트를 하다보면 API 문서를 제공할 일들이 많은데WIKI같은곳에 정리하다보면 그때마다 업데이트 하기가 쉽지 않다그래서 이러한 문제를 해결해 주는게 REST Docs이다의존성을 추가하고test에 config를 만들어 Bean을 주입한다(이러면 문서가 가독성이 좋아진다 prettyPrint)그 후 ControllerTest에서@Import와 @AutoConfigureRestDocs를 해준다 이제 Test에 Rest Docs를 작성해주면된다문서 만드는 법은 보통-요청 본문 문서화-응답 본문 문서화-링크 문서화-요청 헤더 문서화-요청 필드 문서화-응답 헤더 문서화-응답 필드 문서화이런 구성으로 만든다앞에서 링크를 문서화 했는데뒤에 응답 필드 문서화에서도 또 하라고 나온..........

스프링 REST Docs 만들기에 대한 요약내용입니다.

자세한 내용은 아래에 원문링크를 확인해주시기 바랍니다.



원문링크 : 스프링 REST Docs 만들기