[ backend ]
[etc] Spring REST Docs와 Swagger UI를 사용한 API 문서화
2025-01-17 15:20:49
프론트엔드(클라이언트)와 백엔드 사이 원활한 협업을 위해서는 API가 필수적으로 작성되어야 한다. 이때 중요한 역할을 하는 것이 바로 OpenAPI, Swagger, Spring REST Docs다.OpenAPI : API를 정의하기 위한 표준 형식 (주로 JSON과 YAML 형식으로 작성)Swagger : OpenAPI 스펙을 기반으로 API 문서를 시각화하는 도구Spring REST Docs : 스프링에서 제공하는 API 문서화 도구Swagger vs. Spring REST Docs스웨거는 컨트롤러에 몇 가지 어노테이션만 달아주면 API 문서를 자동으로 만들어준다. 문서화가 간편하다는 장점도 있지만 단점도 가진다.스웨거 어노테이션과 비즈니스 로직이 섞인다 (침투적)테스트가 없어 문서의 신뢰성이 낮다 ..