위코드 파운데이션 과정을 들으며 정리한 내용입니다.

path parameter 란?

서로 다른 데이터이지만 resource(자원)의 종류가 동일 할 때 Path parameter 를 사용합니다. path 는 경로 parameter 는 매개 변수입니다. 아래처럼 product 의 1이라는 변수를 사용해 해당 데이터를 불러올 수 있습니다.

// 요청
GET http://10.58.4.1:8000/product/1

// 응답 
{
	"id" : 1,
	"name" : "레스트풀한 문서",
	"price" : "700원",
}

POST 메소드는 데이터를 저달할 때 사용하므로 path parameter 를 사용하지 않을 수 있지만 PATCH 메소드는 특정 리소스를 지칭하여 수정하므로 path parameter 로 어떤 데이터를 수정할지 알려줄 수 있습니다.

query parameter 란?

url 에 특정 조건을 줄 때 사용하는 매개변수 유형입니다. 같은 API 를 호출하더라도 서로 다른 조건으로 나열해야 할 때 사용합니다. 같은 상품 목록이지만 신상품 순, 낮은 가격 순으로 데이터를 호출하기 위해 API 를 구성할 수 있습니다. url 끝 물음표 뒤에 나오며 and 기호로 구분된 이름=값 쌍으로 구성합니다.

// 가격이 3000원인 데이터만 전송
GET / products?price=3000원

// 가격이 3000원이면서, 동시에 이름이 사과인 데이터 전송
GET / products?price=3000원&name=사과 

// 정렬, 동일한 데이터 지만 순서를 바꾸어야 할 때, id 순서를 반대로
GET / products?ordering=-id

// 데이터가 많을 경우, 정해진 수만큼 호출하는 방법, pagination, 데이터 시작점 offset, 주고 받을 데이터 갯수 limit 
GET / products?offset=0&limit=100