목록Spring REST Docs #Swagger #JAVA #REST API (1)

HoneyBee

Spring REST Docs + Swagger UI

요약 AS-IS 현재 API 문서 작성을 위해 Controller 위에 API 문서 작성을 위한 어노테이션 사용 중 정의에 대한 내용이 들어가다보니 코드가 간결하지 않고 복잡성이 더해짐. TO-MAYBE controller에 어노테이션 삭제 → 코드 간결화 Spring REST Docs 활용하여 API 문서 작성 TEST code 실행 후 성공 시에만 API 문서 생성 가능 생성된 REST Docs 파일을 Swagger-UI를 통해 출력 Swagger vs Spring REST Docs Swagger 장점 어노테이션 추가로 API 문서 자동 생성 UI 를 통해 바로 테스트 가능 단점 controller 로직이 지저분함 운영코드에 스웨거 애노테이션이 침투하기 시작하며 생각보다 많은 코드를 작성 Swagge..
Language/Java 2024. 2. 29. 17:48
이전 Prev 1 Next 다음