<aside> 📌 역시 SpringDocs를 학습할 예정이므로 Swagger 내용도 함께 적는다. 필요한 경우 나중에 분리하여 컨텐츠를 관리하도록 한다.

</aside>

REST API로 구성된 환경에서 클라이언트 측에서 서버와 원활하게 요청과 응답을 주고 받을 수 있도록 API를 명세화한 것을 말한다. API 호출에 대한 URL, request body, query parameter 등 HTTP 요청에 필요한 정보를 정리하여, 클라이언트 측에서 올바르게 API를 호출할 수 있도록 한다. 클라이언트 측에서 API 엔트리 포인트를 담당하는 프론트와의 협업을 위해 작성이 필요하다.

Swagger vs. Spring REST Docs

Spring REST Docs

슬라이스 테스트 결과를 문서화 하기