API 명세서, 스웨거로 마이그레이션

[ori0o0p]

목적

현재 API 명세서를 노션으로 관리하고 있지만, 제대로 유지보수가 되지 않고 있습니다. 스웨거를 통해 효율적으로 API 명세서를 관리합니다.

---

요구사항

1. 스웨거(Swagger)를 프로젝트에 통합.

---

작업 세부사항

• 스웨거 의존성 추가
  • Springdoc-openapi 또는 Swagger UI 의존성 추가.
• Swagger 설정 클래스 작성
  • API 명세의 제목, 설명, 버전 설정.
• 엔드포인트에 Swagger 어노테이션 적용
  • 가독성을 위해 Documentation 파일에 어노테이션 적용 후 컨트롤러 레벨에서 구현
  • 주요 요청/응답 DTO에 어노테이션 추가.
• Swagger UI를 통해 결과 확인
  • /swagger-ui.html 또는 /v3/api-docs에서 문서가 제대로 생성되었는지 확인.

---

예상 완료 날짜

2024년 11월 30일

---