웹 개발 API URI작성에 관한 질문..!

Question

안녕하십니까..!저는 올 초부터 웹 개발에 흥미를 느껴 독학 중인 학생입니다.이번에 API문서 작성에 관한 강의를 듣고 개인 프로젝트에 대한 API문서를 작성해보던 도중 한 가지 의문이 들어 현직 멘토님들의 의견을 여쭙고자 글을 작성하게 되었습니다.저의 의문은 마이페이지에 관한 URI를 작성하면서 생겼습니다. 유저 정보 조회라는 기능에 대한 URI를 처음에는 [GET] '/users/me'로 설정했습니다. 물론 토큰 같이 사용자 인증을 거치기는 하겠지만 애초에 사용자가 PK값을 변경하면서 다른 유저의 정보를 조회하려는 시도 자체를 막는 편이 좋다고 생각했기 때문입니다. 그런데 커뮤니티 글이나 다른 블로그 글들을 보면(커뮤니티 글) [GET] '/users/{userID}' 방식을 쓰시더라고요... 다른 외국 API문서들도 약간 '/api/v1/~~~/1' 이런 느낌으로 작성된 경우도 있고요..글들을 읽어봐도 뭔가 명쾌하게 이해가 되지 않더라고요어차피 유저인증은 따로 거칠 것인데 왜 굳이 유저PK를 모두가 볼 수 있는 URI에 노출시켜야 하는지 잘 모르겠습니다..ㅠㅠ또 현직 종사자 분들 입장에서 느끼는 좋은 API는 무엇일까요?

doooss · Accepted Answer

users/me 가 더 적합하시다고 생각하시니 이 부분 설명을 생략하고 ~/users/{userId} 로 작성하는 케이스의 의도 생각해보겠습니다. 1. RESTful한 url 입니다. 2. user/me 와 달리 접근 권한이 있는 유저가 다른 유저의 정보를 알수 있습니다. (ex 어드민 유저의 접근) 개인적으로는 로그인 유저의 정보는 users/me 로, 어드민 페이지 에 대비하여 /users/{userId} 도 병행하시는 것을 추천 드립니다.

캐티 · Answer

세션을 사용하면 무언가 추가적인 작업이 수행되는데요. 메모리캐싱 또는 파일캐싱을 불러오거나 레디스 백플레인에서 세션을 조회하는데 이렇게 까지 유지 비용을 들일 필요가 없는 경우 쿠키,토큰 이밖에 원래 유저아이디를 위의 예시처럼 처리해요.유저 고유값은 안 쓰면 되는 것이고 암호화 해둘 수도 있으며 이것은 양자 컴퓨터를 사용하지 않는 한 열어보기 어려울 것이어요.

장독깨기 · Answer

마이페이지 같은 경우, 굳이 사용자아이디를 표시할 필요 없어 보입니다.이유는 말씀하신거처럼 인증정보로 사용자아이디를 알 수 있기 때문이죠.저도 별도로 사용자 아이디 표시하지 않습니다.

Bluebell · Answer

점차 get이 아닌 post로 하고 서버에서 인앤 아웃 하는 편이긴 하는데... 사실 하다 보면 빡치자나요..? 그런 개념에서 get으로 넘기긴 했었다고 하던데... 요새는 보안 때문에 조심해야하긴 합니다. 근데 쓸때는 쓰.... 결론은 알잘딱깐센 하래요.

공급 · Answer

결국 센스껏 해야겠네요... 모든 분들 답변 감사합니다!

웹 개발 API URI작성에 관한 질문..!

5개의 답변

#uri 목록