[ALL] RESTful API 디자인 원칙에 기반하여 기존 API path를 수정

[seokmyungham]

관련 이슈

• resolves: [ALL] RESTful API 디자인 원칙에 기반하여 기존 API path를 수정해요 :) #104

작업 내용

RESTful API 디자인 원칙에 기반하여 현재 구현되어 있는 API Path를 개선하였습니다.

Path 변경 사항

기능	HTTP 메서드	URI 경로
참가자 로그인	POST	/api/v1/meetings/{uuid}/login
약속 정보 생성	POST	/api/v1/meetings
약속 정보 조회	GET	/api/v1/meetings/{uuid}
약속 공유 조회	GET	/api/v1/meetings/{uuid}/sharing
일정 생성	POST	/api/v1/meetings/{uuid}/schedules
약속의 모든 일정 조회	GET	/api/v1/meetings/{uuid}/schedules
약속의 특정 회원 일정 조회	GET	/api/v1/meetings/{uuid}/schedules?attendeeName=
약속의 내 일정 조회	GET	/api/v1/meetings/{uuid}/attendees/me/schedules

특이 사항

• 자원 식별 혼동을 줄이기 위해 모든 자원에 대해 복수형 명사를 사용하였습니다.
• uuid를 사용하는 path에 일괄적으로 meetings를 명시하여 계층 구분을 명확히 하였습니다.
• 약속의 내 일정 조회 기능의 경우 현재 인증된 사용자 정보로 일정에 접근하는 의미를 명확히 하도록 수정하였습니다.
  • 자원의 계층을 분리하여 URI 일관성을 유지하였습니다.
  • me 키워드를 통해 현재 일정 자원에 접근하는 참가자가 인증된 참가자라는 의미를 포함합니다.

리뷰 요구사항 (선택)

[github-actions]

Test Results

47 tests   47 ✅  4s ⏱️
14 suites   0 💤
14 files     0 ❌

Results for commit 202b514.

♻️ This comment has been updated with latest results.

[hwinkr]

고생하셨습니다~
소통을 위해서 자원 식별 경로를 복수형으로 변경한 것 좋네요!

[hw0603]

👍

[Yoonkyoungme]

🎺🎷재즈🎺🎷 고생하셨어요👍👍👏

약속의 내 일정 조회	GET	/api/v1/meetings/{uuid}/attendees/me/schedules

me → current도 가볍게 제안드려 봅니다!

약속의 내 일정 조회	GET	/api/v1/meetings/{uuid}/attendees/current/schedules

[ikjo39]

좋네요~

[seunghye218]

모호했던 API URL이 일관되고 명확해졌네요😄

[ehBeak]

더 명확해졌네요~! 💯

[Largopie]

REST API 관련된 레퍼런스도 함께 이슈에 첨부해주어서 이해하는데 많은 도움이 되었어요! 고생하셨습니다 :) 훨씬 직관적인 것 같네요 👍