swagger

1️⃣ Swagger와 Rest Docs의 특징Rest API를 개발할 때, 흔히 Swagger 또는 Rest docs를 사용해서 API 명세서를 편리하게 작성합니다.두 방법은 각각 명확한 장단점을 가지고 있습니다.SwaggerController와 Dto에 어노테이션 코드를 작성해서 API 명세서를 작성합니다. API 명세서를 위한 코드와 어플리케이션 코드가 함께 혼합되어있어 가독성이 떨어질 수 있습니다.API를 호출할 수 있는 웹 기반 UI가 제공됩니다.Rest Docs컨트롤러 테스트 코드를 작성해 API 명세서를 작성합니다. 자동으로 만들어진 adoc 문서 외에 구조나 목차등은 수동으로 작성해야 합니다.정적인 문서만 생성하기 때문에 swagger 처럼 API를 호출할 수 있는 웹 기반 UI는 제공되지..

Swagger는 API를 호출하는 Controller 및 Model에 몇가지 설정만 추가해주면, 직접 작성하지 않아도 편리하게 Rest API를 문서화해줍니다.Swagger를 이용해 API문서를 생성하는 과정을 기록해보겠습니다.0️⃣ 환경Spring Boot 2.7Spring securitygradle 1️⃣ Swagger 종속성build.gradle에 Swagger 라이브러리를 사용하기 위해 종속성을 추가해줍니다.implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '..