Request Parameter 종류

혜진 조·2022년 7월 5일
2

기타

목록 보기
1/4

REST API의 파라미터에는 4가지 타입이 있다.

  • header 파라미터: 리퀘스트 헤더에 포함된 파라미터. 보통 인증 혹은 권한 부여에 관련되어 있다.
  • path 파라미터: 엔드포인트에서 쿼리문 이전의 파라미터.
/service/myresource/user/{user}/bicycles/{bicycleId}
  • query string 파라미터: 쿼리문 내의 파라미터. 엔드포인트가 끝난 뒤 물음표 뒤에 온다.
/surfreport?days=3&units=metric&time=1400

가끔 path 파라미터와 query 파라미터 중 무엇을 사용할지 고민하곤 하는데, REST API의 모범을 준수하자면 path 파라미터는 특정 리소스를 정의할 필요가 있을 때, query 파라미터는 정렬 혹은 필터링이 필요할 때 사용한다.

  • request body 파라미터: 리퀘스트 바디에 포함된 파라미터. 보통 JSON 형식으로 제출된다. 보통 데이터를 보내야하는 POST 리퀘스트에서 사용되다.
{ 
  "days": 2,	
  "units": "imperial",	
  "time": 1433524597
  }
출처: https://yuda.dev/250 [YUDA't:티스토리]
profile
나를 믿고 한 걸음 한 걸음 내딛기! 🍏

0개의 댓글