Framework/Spring
[Spring] Spring REST Docs API 문서 만들기
아래 내용은 Spring REST Docs를 사용하면서 정리해둔 내용입니다. API 문서 자동화 백엔드와 프론트엔드 개발자 사이의 원활한 협업을 위해서는 REST API 명세에 대한 문서화가 잘 되어있어야 한다. 물론 구글 독스, 스프레드 시트, 위키, 노션 등을 사용해서 직접 API 명세를 문서화할 수 있지만, 우리는 개발자 아니겠는가. 자동화를 해야지만 무언가 나도 편하고 간지도 난다. API 문서 작성을 도와주는 자동화 도구가 많은데, Java Spring 진영에서 가장 많이 쓰이는 API 문서 자동화 도구는 크게 Swagger와 Spring REST Docs 이 두 가지가 있다. API 문서 자동화 도구 : Spring REST Docs 테스트 도구 : MockMvc(@WebMvcTest) 문서 ..
2023. 8. 7. 13:32