[BE] API 사용처 파악 및 명세 개선

[yoondgu]

🛠️ 작업 대상

• 현재 사용 가능한 모든 API

✅ 작업 내용

• 현재 사용 가능한 모든 API 중, 실제 사용처를 파악합니다.
• 사용하지 않는 API가 무엇이 있는지 인지하고, 개선할 수 있는 부분을 개선합니다. (삭제 또는 명세 수정 등)
• 현재 RestDocs에서 응답이 500으로 표기되는 부분을 함께 수정합니다.
• RestDocs에서 이미지 관련 API와 같이 누락된 API 명세를 추가합니다.

방법 1

• 프론트엔드에게 코드 상 사용하는 API 목록을 요청한다.
  • 장점: 당장 편하다
  • 단점: 프론트엔드는 귀찮을 수 있다ㅎㅎ

방법 2

• API 별 호출을 확인 가능한 ControllerLogInterceptor를 만든다. (access log로는 바로 이를 파악하기가 어렵기 때문에)
  • 장점: 실제로 어떤 API 요청이 가장 많이 들어오는지 확인하기 좋다.
  • 단점: API가 아주 많은 것이 아닌데, 굳이 이렇게 할 필요가 있을까? (레퍼런스의 경우 API만 150개이고, 엘라스틱서치를 사용하지만 우리는 그렇지 않다)

프론트 - 백엔드 공동 작업을 하면서 예상하지 못한 API 사용이나, 실제로 사용하지 않고 있는데 API가 제공되고 있는 등
API 사용 현황을 파악하기 어려운 상황이 많았습니다.
이를 정리하면서 API 명세 개선을 함께 진행하면 좋을 것 같습니다.

📎 참고 자료

방법 2에 대한 레퍼런스입니다.
[우아한 기술블로그] Spring 웹 애플리케이션에서 사용하지 않는 API를 찾아보자

⏰ 추정 시간

비관적 추정: 명세 개선 포함하여 10시간
낙관적 추정: 명세 개선 포함하여 5시간