RESTFUL API 간단한 질문입니당

Question

쿼리파라미터랑 pathvariable의 차이를 비교하던 중 pathvariable을 사용하면 자원을 명시할 수 있고 자원을 명시하는게 Restful 의 원칙이란 건 이해했습니다.또한 쿼리파라미터는 sorting이나 paging 에 사용된다는 것도 이해했구요근데 이렇게 자원을 명시함으로써 어떤 장점이 있는지 좀 와닿지가 않습니다.예를 들면 /api/member/1 이거랑 /api/member?memberId&#61;1 이거랑 당연히 전자가 맞을 것같으나왜 전자가 맞는지, 정확히 어떤 장점이 있는지 , 만약 후자로 표시하면 어떤 후과가 있는지예를 들거나 설명해 주실수 있을까요??

장독깨기 · Accepted Answer

맞고 틀리고 특별한 장점이 있고 이런 거 없습니다.그냥, 자원을 하이라키로 표현해보자 이런 일종의 약속 같은 겁니다.물론 후자로 해도 특별한 단점도 없구요.실제 현업에서 저렇게 전자로 하지 않는 경우도 많습니다.

팩트폭행범 · Answer

직관적이잖요사람이 짜는 코드는 계속 직관적으로 눈에보기 좋게 발전해왔습니다SOLID법칙도 그렇고 DRY법칙도 그렇고요 KISS법칙도 있습니다.

kenu,전독시 · Answer

서비스 만들면서 경험해야 알 수 있을 겁니다.이게 말로 해서 100% 이해가능한 비유가 어렵습니다.

olivahn · Answer

REST는 지금 질문하신 내용과 큰 관계가 없습니다. 엄밀히 말하면 HTTP API의 모범사례로 소개되는 것이죠.

Oyatrij · Answer

이게 맞는지 모르겠지만..제가 알기로는간단하게 RESTful 은 API 설계 규칙이고 여러 장점이 있겠지만 GET POST PUT DELETE 등 을 보고 "아 이 API 가 뭘 하는 자슥이겠구나.." 할 수 있도록 만든 규칙 이라고 알고 있습니다./api/member/1 의 HTTP method 가 GET 이라면 "아..이자슥이 id 가 1 인 member를 조회하겠구나.." 혹은, POST라면 수정이겠구나 DELETE는 삭제겠구나 알 수 있는 것 처럼요..반면 /api/member?memberId=1 라고 해놓고 HTTP method 가 GET 인데 백엔드에서 memberId 로 1 이라는 값을 받아서 뭐 memberId 가 1인 녀석을 조회하는지 1인녀석의 row를 지워버리는지 수정하는지 정확하게 알 수 가없고 이는 RESTful 하지않다. 즉, RESTful 한 API 설계 원칙에 어긋난다 라고 말할 수 있을 것 같습니다.저도 초보라.. 고수분들의 첨삭 부탁드립니다 ㅎㅎ

kkoko · Answer

1. **가독성과 직관성:** - Path variable을 사용하면 URL 자체에서 리소스를 명시적으로 식별할 수 있어 가독성이 높습니다. `/api/member/1`은 멤버 1번을 나타내는 명시적인 주소입니다. - 반면에 query parameter를 사용하면 URL이 어떤 자원을 나타내는지 직관적으로 알기 어려울 수 있습니다.2. **Restful 원칙:** - RESTful API에서는 자원을 명시하고 표현하는 것이 중요합니다. Path variable을 사용하면 URL 자체가 이를 나타내므로 RESTful한 디자인에 부합합니다.3. **캐싱 및 북마크:** - Path variable은 캐싱이나 북마크에 유용합니다. 예를 들어, `/api/member/1`을 북마크하면 항상 동일한 멤버를 참조할 수 있습니다. 반면에 query parameter를 사용하면 이러한 안정성이 떨어질 수 있습니다.4. **검색 및 필터링:** - Query parameter는 데이터 검색이나 필터링에 유용합니다. `/api/members?status=active`와 같이 특정 조건을 쿼리로 전달할 수 있습니다.경우에 따라서는 특정 요구사항이나 프로젝트의 컨텍스트에 따라 선택되지만, RESTful한 디자인과 가독성 측면에서 path variable을 사용하는 것이 일반적으로 권장됩니다.ChatGpt 답변이네요

RESTFUL API 간단한 질문입니당

6개의 답변

기술 목록