- Swagger는 Spring Boot 애플리케이션에서 널리 사용되는 API 문서화 도구, 개발, 테스팅을 지원
- Swagger의 주요 목적과 활용 방법
- API 문서화
- Swagger를 사용하면 RESTful API의 엔드포인트, 파라미터, 데이터 형식 등을 쉽고 명확하게 문서화
- 인터랙티브한 UI 제공
- Swagger UI는 API의 문서화를 웹 페이지로 제공하며, 사용자가 직접 API 엔드포인트를 테스트할 수 있는 인터페이스를 제공
- Swagger사용 방법
- 의존성 추가
- implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0’
- 문서화를 위한 어노테이션 사용
- Controller 클래스나 메소드에 @Operation 등과 같은 Swagger 어노테이션을 추가하여, API의 세부 정보를 문서화
- @Operation 어노테이션은 메서 API의 작업(Operation)을 설명하는 데 사용
- 예시) @Operation (value = "회원가입", notes = "이메일, 비밀번호 등을 입력받아 회원가입을 처리합니다.")
- ControllerAdvice는 Swagger문서에서 api대상에서 예외
- 로그인 테스트
- SwaggerConfig 파일을 생성하여, 인증의 종류와 방식을 선택
- Swagger UI 접근