REST API 설계 고민

[f1v3-dev]

현재 상황

GET /api/books/{memberBookId} API를 기준으로 설명합니다.

• 비회원 / 책장 주인이 아닌 회원 / 책장 주인 회원 모두 접근이 가능해야 함.
• 현재는 Authorizatino Header 를 통해 요청자 정보를 확인하는 상태

위의 API 뿐 만 아니라, 전체적으로 다른 사용자의 페이지(홈, 책장, 책 상세보기)에 대한 처리가 명확하지 않은 상태입니다.

이로 인해서, 1) 계층형 URI 구조 적용, 2) 현재 URI 유지 + 응답에 소유자 정보(ownerId) 추가 두 가지 케이스를 생각을 해봤어요.

방안 1. 계층형 URI 구조

GET /api/members/{ownerId}/books/{memberBookId}

장점

• 리소스 소유 관계를 URI에 명확하게 표시
• 조금 더 RESTful 원칙에 부합하는 구조

단점

• 프론트엔드에서 홈(/home), 책장(/books)와 같은 형태로 이동하며 토큰 기반으로 API를 호출하고 있어 백/프론트 둘 다 변경하는 작업이 불가피해보입니다. (이건 필수인 것 같아요.)

방안 2. 현재 URI 유지 + 응답에 소유자 정보(ownerId) 추가

GET /api/books/{memberBookId}

장점

• 기존 API 호환성을 유지

단점

• 리소스 소유 관계가 URI에 명확하게 드러나지 않음

---

위와 같은 상황이라 제 생각은 다음과 같아요

1. 방안 2를 도입해서 기초적인 처리를 가능하게 한다.
2. API 버전을 새로 만들어서 (v2) 방안 1처럼 처리를 한다.
3. 프론트 분들에게 새로운 API를 전달드리면서 프론트 라우팅을 수정한다.

어떤 방식으로 처리하는게 좋을까요?