Path Variable vs Query Parameter

✅ 아래 내용들에 대해서 알아보자

- Path Variable
- Query Paramter(String)
- 각각 언제 사용해야 하는가?
- 정리

 

 

Path Variable

 pathVariable은 url 경로에 변수를 포함하는 방식이다. User와 관련된 API를 설계해보자.

GET        .../users/11    -> id가 11인 유저 찾기
POST     .../users         ->유저 등록
PATCH     .../users/11   ->id가 11인 유저 수정
DELETE .../users/11     ->id가 11인 유저 삭제

 

 

Query Parameter

 queryParamter는 url끝에 ?와 함께 ket-value쌍을 포함시키는 방식이다. 성별이 남자인 유저를 찾는 API를 설계해보자.

GET .../users?sex=man  

 

 

각각 언제 사용해야할까?

 Path Variable은 특정 resource를 식별하고 싶을때 사용하고, 정렬이나 필터링을 한다면 Query Parameter를 사용하는 것이 좋다.

 

REST API 가이드에 맞게 도메인(자원)별로 잘 나누어서 적절한 HTTP Method와 URL을 설계하도록 습관을 들이는것이 Best Practice이지 않을까 생각한다.