[5주차] 나명준/[feat] Swagger 문서화

[Nanajun22]

1. 과제 요구사항 중 구현한 내용

• 기존에 구현 중인 서버 프로젝트에 Swagger를 추가한다.
• 실행 후 Swagger UI 페이지에 접속할 수 있어야 한다.
• 현재 프로젝트에 구현되어 있는 API가 Swagger 문서에 표시되어야 한다.
• 문서를 보고 각 API의 요청 방식과 URL, 요청값, 응답값을 확인할 수 있어야 한다.

2. 핵심 변경 사항

• OperationCustomizer 구현을 통한 에러 예시 자동화
• 문서화 인터페이스 분리

3. 실행 및 검증 결과

• 실행 결과:

• API 요청 응답 테스트:

-예외 상황 문서화:

4. 완료 사항

1.API 문서화
2.API 요청 응답 테스트

5. 추가 사항

• 관련 이슈: closed [5주차] 나명준/[feat] Swagger 문서화 #171

제출 체크리스트

• PR 제목이 규칙에 맞다
• base가 {이름}/main 브랜치다
• compare가 {이름}/{숫자}주차 브랜치다
• 프로젝트가 정상 실행된다
• 본인을 Assignee로 지정했다
• 파트 담당 Reviewer를 지정했다
• 리뷰 피드백을 반영한 뒤 머지/PR close를 진행한다

Reviewer 참고