토마의 엔지니어링 노트

안녕하세요. 오늘은 Swagger UI를 사용해서 API문서를 자동화하는 방법에 대해서 포스팅하려고 합니다. 1. Why Swagger? 최근 Restful API를 많이 사용하면서, 클라이언트와 협업을 하기 위해서는 API문서가 중요합니다. API를 개발한 뒤, 수정사항이 빈번하게 발생해 API를 수정하게 되면, 문서를 일일히 수정하는 것은 많은 시간을 소요하게 됩니다. 따라서, API 문서를 자동화 하는게 좋은데, API 문서를 자동화 해주는 것들 중 IODocs와 Swagger 등이 많이 사용된다고 합니다. 오늘은 그 중 Swagger UI를 설정하고 간단하게 사용하는 방법에 대해서 포스팅하도록 하겠습니다. 2. 설정 방법 우선, 아래와 같이 pom.xml 파일에 dependency를 추가해줍니다...