Path Parameter VS Query Parameter

정승렬·2022년 9월 10일
0

Path Parameter란?

특정 리소스를 가르키는 URL(endpoint)
ex)
GET http://10.58.4.1:8000/products
(제품 전체의 정보 호출)
GET http://10.58.4.1:8000/products/1
(1번 제품의 데이터 호출)

Query Parameter란?

url에서 특정한 조건을 주고싶을 때 사용하는 매개변수 유형
같은 API를 호출한다고 해도, 서로 다른 조건으로 나열하는 것이 필요한 상황에 사용
URL 끝에 물음표(?) 뒤에 나타나며, and 기호(&)로 구분된 이름=값 쌍으로 구성되어 있다.

Query Parameter는 HTTP의 [GET], [DELETE] 요청에서만 사용하고, 유일 값을 식별하기 위한 용도가 아닌 옵션을 줄 때 사용한다.
크게 다음과 같은 상황에서 사용한다.

  • 데이터 필터링
  • 데이터 정렬
  • 데이터 수 조절 (페이지네이션)
  • 검색 등

ex)
필터링
GET/products?price=3000원
GET/products?price=3000원&name=사과

정렬
GET/products?ordering=-id

데이터 수 조절
GET/products?offset=0&limit=100

검색
GET/users
GET/users?search=홍길동

0개의 댓글