Swagger 개선기 feat. 커스텀 어노테이션, ISP (인터페이스분리원칙)
컨트롤러에 스웨거 애노테이션이 뒤엉켜 서버 코드가 읽히지 않자, 인터페이스 분리 원칙을 적용해 문서용 인터페이스를 떼어내고 반복되는 정의는 커스텀 어노테이션으로 묶은 개선기.
작성날짜: 24.08.30
상황
- 기존
spring rest docswagger ui적용된 상황 - 하지만, 컨트롤러내 스웨거 코드가 서버 코드와 혼재되어 있어 유지보수 및 개발 어려움
개선 방향
- 스웨거 유지보수 및 개발 편하게 별도 분리
개선된 전체 구조
특징1. 인터페이스 분리 원칙
특징2. 단일 책임의 원칙
특징3. 커스텀 어노테이션
개선 회고
- 코드 가독성 향상
- 유지보수 용이성
- 개발 일관성