Query String 과 Path Variable

hatban·2024년 9월 23일
0

https://medium.com/@fullsour/when-should-you-use-path-variable-and-query-parameter-a346790e8a6d 를 참조했습니다!


리스트같은 여러 데이터의 묶음을 다룰때 특정데이터만 노출시킨다거나 특정 조건의 데이터만 노출시키고 싶을때 Query Parameter나 Path Variable을 사용할 수 있다

Query Parameter

  • query parameter는 url의 끝에 ? 이후로 시작되는 부분인데 key=value 형태로 표현하며 &로 연결한다
/items?id=123  // 123번 아이템 조회

Path Variable

  • 경로를 변수로 사용하는 방식이다
/items/123  


언제 무엇을 사용할까?

  • 리소스를 특정하고 싶은 경우 path variable을, 필터링이나 정렬이 필요할 시 query string을 사용한다

http 메소드에 따라 보자면

Path Variable

GET

  • 목적에 따라 다르다
/items    // items 전체 목록 조회
/items/123   // 123번 아이템 조회

POST

  • post요청의 경우 데이터 저장에 사용되므로 변수 필요 없다
/items    // 아이템 생성

Patch

  • 특정 데이터를 지칭해서 수정하기 때문에 변수 필요
/items/123    // 아이템 생성

Delete

  • 특정 데이터를 지칭해서 삭제하기 때문에 변수 필요
/items/123    // 아이템 생성


Query String

  • HTTP GET, DELETE 요청에서만 사용한다
  • 값의 식별이 아닌 옵션을 위한 사용
    GET
  1. 필터링
/items?price=3000    // 3000원인 아이템 조회
  1. 정렬
/items?order=popular    // 아이템 인기순 정렬
  1. 데이터 수(pagenation)
/items?offset=0&limit=10   // 0~10아이템 조회
/items?offset=10&limit=20   // 10~20아이템 조회
/items?page=1				// 1페이지 아이템 조회
  1. 검색
  • 사실상 필터링과 같은 기능
/items?search=브로콜리   //브로콜리 검색

0개의 댓글