[기능] 분석 서비스 API 수정 요청

[NarciSource]

📌 필요한 작업

분석 서비스 API의 수정을 요청

📝 작업할 항목

• 스웨거UI

  • 스웨거 페이지에 Authorization 입력 칸이 없어서 작동을 못해요. 수정해주세요.
  • 예시가 빠진 것들이 있어요.

• 공통

  • api의 uri 이름을 명확히 해주세요. 보고서 문서 하나를 사용하면 report, 보고서 문서 묶음을 사용하면 reports
    그러니 GET, PUT, POST, DELETE /reports 주소는 /report 가 더 맞아요.
  • 또한 보고서 리스트면 더 많은 정보 제공인데 오히려 하위 uri로 들어가있는 것도 어색해요.
    /reports/list보다 여기가 /reports 가 되는게 낫겠어요.

• API

  • companyDetails와 industryDetails는 배열 형태인데 List<CompanyDetail>
    정작 원소는 항상 하나만 들어가요. 배열을 해체해주세요.
  • GET, PUT, DELETE /reports는 category와 createdAt 쌍으로 식별키를 보내게 하고 있어요.
    이건 FE에서 너무 불편해요. 해당하는 문서를 즉시 가져올 수 있도록 문서 id를 사용하는 것으로 바꿔주세요.
  • GET /reports/list는 전체 리스트를 조회하는 기능이에요.
    현재 전체 리스트를 조회할 상황이 없긴해요. 필요한 것은 네비게이터 역할로 사용할 요약 정보에요.
    이 uri를 요약 정보 제공으로 바꾸던지 아니면 놔두고 요약 정보 GET이 필요해요.
    요약 정보는 반환 값으로 companyDetails 등이 필요 없고 대신 해당 문서 id가 필요해요.

📚 추가 정보

JSON:API 권장 표준 가이드 https://jsonapi.org/