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

부제 : SWAG하게 Swagger 사용하는 법 🤟 누구를 위한 Swagger인가 Swagger는 API 문서를 간편하게 작성하도록 돕지만, 너무 많은 데코레이터들은 오히려 코드의 가독성을 해친다. FE분을 위해 작성한 Swagger 데코레이터들이 막상 BE 본인의 코드를 망치는 아이러니한 상황인 것이다. 😑 : API 문서가 필요한 건 FE분들인데 왜 제 코드가 더러워져야 하죠? 그렇다고 Swagger 데코레이터를 제거하면 별도의 문서화 작업이 필요하고, FE분들과 사이도 원만하지 못하게(?) 된다. 내가 작성한 비즈니스 로직을 어지럽히지 않으면서 Swagger 데코레이터를 작성할 방법이 없을까 고민하다가 커스텀 데코레이터를 만들기로 결정했다. 코드 중복을 최소화한 데코레이터 커스텀 데코레이터는 nes..