rest docs1 Spring Rest Docs 사용하기 토이 프로젝트에서 Spring Rest Docs를 사용하면서 프로젝트 API의 문서화를 적용하며 내용을 정리해본다. API 문서API 문서란 웹 애플리케이션을 개발하면서 만들어진 HTTP API를 개발자나 사용자 입자에서 쉽게 이해할 수 있도록 문서화한 자료를 말한다.API의 사용 방법, 엔드 포인트, 요청 및 응답 구조 등을 담고 있다.API 문서를 생성하는 이유API 문서는 팀 내부, 외부 개발자 및 사용자로 하여금 API를 이해할 수 있게 도와준다. API 문서가 없다면 직접 소스를 보고 파악해야 할 수도 있다.API 문서를 제대로 작성하면 시스템의 변경이 있을 때 영향이 있는 부분을 파악해서, 유지보수성을 높일 수 있다.백엔드, 프론트엔드 협업 시 프론트드 개발자들이 API 문서를 통해 인터페이스.. 2024. 8. 23. 이전 1 다음
