Swagger UI는 개발자들이 API를 더 효과적으로 개발하고, 테스트하고, 문서화하고, 사용하게 해주는 도구입니다. API의 정의를 바탕으로 자동으로 문서를 생성하므로 시간을 절약하고, 실시간으로 문서를 업데이트하므로 동기화 문제를 해결합니다. 또한, 대화형의 인터페이스는 API를 더 쉽게 이해하고 테스트하게 해줍니다.
NestJS는 @nestjs/swagger 패키지를 사용하여 Swagger 문서를 자동으로 생성합니다. 데코레이터를 사용하여 API 엔드포인트와 모델에 메타데이터를 추가할 수 있습니다.
Spring Boot에서는 Springfox 라이브러리를 사용하여 Swagger 문서를 자동으로 생성할 수 있습니다. Springfox는 Spring MVC의 @Controller 및 @RestController 빈에 정의된 요청 매핑 정보를 분석하여 Swagger 문서를 생성합니다.
API 문서를 수동으로 작성하는 것은 많은 시간이 소요되며, API 수정 시에 동기화되지 않는 문제가 발생할 수 있습니다. 시간과 자원의 부족, 혹은 문서화의 중요성 인식 부족으로 인해 API 문서가 없거나, 수동으로 API 문서를 만들고 있다면 시간을 절약하고, 문서의 정확성과 일관성을 유지하는 데 도움을 주는 Swagger UI를 추천합니다.
https://swagger.io/tools/swagger-ui/