[API] Path parameter VS Query Parameter

Yuzu·2023년 2월 2일
0

Path parameter

정의

  • URL로 고유한 자원(resource, data)을 지칭
    ex) http://naver.com/stocks //주식 정보
  • 특정 자원을 가리키는 url 경로에 가변적인 부분
    ex) http://naver.com/stocks/kakao //카카오의 주식 정보
  • path parameter : 변수로 지정해둘 수 있다, ‘특정 리소스를 가리키는' URI, 유일한 값을 식별하는 역할
    ex) http://naver.com/stocks/:companyName //백엔드 서버 라우팅
  • 서로 다른 데이터지만 resource(자원)의 종류는 동일할 때, path parameter를 이용하여 RESTful한 API를 구성
  • 모든 메서드에서 사용 가능

사용예시

Query parameter

정의

  • url에서 특정한 조건을 주고싶을 때 사용하는 매개변수 유형
  • 동일한 API 호출, 서로 다른 조건으로 나열 (옵션을 준다)
  • URL 끝에 물음표(?) 뒤에 나타나며, and 기호(&)로 구분된 이름=값 쌍으로 구성
  • HTTP의 [GET], [DELETE] 요청에서만 사용
  • ex) 데이터 필터링, 데이터 정렬, 페이지네이션, 검색 등

사용예시

  1. products 데이터를 id 역순으로 정렬하는 query parameter
    [GET] /products?ordering=-id
  2. 동일한 키값으로 여러 값을 전달할 경우, 서버에서는 배열로 값을 받을 수 있다.
    [GET] /products?size=230&size=240&size=280 → { size : [230, 240, 280] }
profile
냐하

0개의 댓글