[서브태스크] Swagger UI

[wintiger98]

Swagger UI 적용하기

개요

• 목표: 스프링 부트 프로젝트에 Swagger UI를 적용하여 API 문서화 및 테스트를 용이하게 한다.
• 마감 기한: [2024-04-01]
• 담당자: [@wintiger98]
• 참고 이슈: [[서브태스크] 개발환경 설정 #18]

상세 설명

이 서브태스크의 목적은 스프링 부트 애플리케이션에 Swagger UI를 통합하여, 개발자 및 사용자가 API를 더 쉽게 이해하고 테스트할 수 있게 하는 것입니다. Swagger UI를 사용함으로써, API의 명세를 자동으로 생성하고, 실시간으로 API를 테스트할 수 있는 웹 인터페이스를 제공합니다.

작업 항목

• Swagger 3 Maven 의존성 추가
• Swagger 3 설정을 위한 Java Config 클래스 생성
• Swagger UI에 대한 접근 권한 설정
• 주요 Controller 클래스에 Swagger 주석 추가
  • 모델 및 메소드 설명 추가
  • 파라미터 및 응답 타입 명시

테스트 항목

• Swagger UI가 성공적으로 로드되는지 확인
• 생성된 API 문서가 정확한 정보를 제공하는지 확인
• Swagger UI를 통한 API 테스트 기능이 정상적으로 작동하는지 확인
  • GET, POST, PUT, DELETE 요청 테스트
  • 요청 파라미터 및 응답 데이터 검증

참고 자료/링크

• Spring Boot Swagger Integration
• Swagger Official Website

기타 주의사항

• API 변경 시 Swagger 주석도 함께 업데이트할 것
• 내부 API는 Swagger에서 제외할 것

피드백

[작업 진행 중 또는 완료 후 팀원들의 피드백을 기록하는 공간입니다. 피드백이 있을 경우, 여기에 추가해주세요.]