BE) URI 설계

Question

BE에서 챌린지 참여에 대한 URI 설계를 하고 싶습니다.JWT 기반 플랫폼입니다.이때, 2가지 요구사항입니다.특정 사용자의 챌린지 참여 횟수 전체 조회관리자가 모든 사용자의 챌린지 참여 횟수 전체 조회그러면모든 사용자의 챌린지 참여 횟수 전체 조회/participations/count특정 사용자의 챌린지 참여 횟수 전체 조회/participations/me/count이렇게 되는게 적절할까요?특정 사용자의 챌린지 참여 전체 조회를 어떻게 표현해야할지 감이 안옵니다../users/{userId}/participations로 하면 depth가 길어지고, 챌린지 참여를 조회하는데 users가 맨 왼쪽에 오니까 헷갈리는 것 같습니다.특정 사용자의 챌린지 참여 횟수 전체 조회는 URI를 어떻게 두어야할까요?

동도인 · Answer

메소드는 조회 이기 때문에 GET 이라는 가정하에.유저 조회가 source 이니 /user 라는 키워드는 들어가는게 좋습니다.유저 전체 조회 API 는/users/participations특정 유저 조회는 글쓴이 처럼/users/{id}/participations와 같이 설계를 할거 같습니다.혹은.. depth 가 너무 길어 고민이라면 다음과 같이 쿼리파라메터를 쓰는 것도 하나의 방법이 될거 같습니다./participations?userId={id}

Bale K · Answer

저는 쿼리파람 사용할 것 같아요~근데 요즘은 swagger 기반의 generator가 잘 되어 있어서 operationId만 잘 지정해도 괜찮지 않나 생각합니다 !

캐티 · Answer

고유값으로 case when 하여도 좋겠지만 특별한 이유가 없음 일반적으로 권장되는 거는 아니고 ?userid=사용자아이디 정석을 따라요. 안그럼 혼나빈다.

BE) URI 설계

3개의 답변

#uri 목록