[TIL] 20240123 REST API request 방식

1. REST API endpoint 설계방식

• Path parameter
• Query string
• Body

path는 특정 리소스를 정의할 때,

query는 정렬 혹은 필터링이 필요할 때 사용함

 

2. Path parameter

• ex) api/resource/{id}

원하는 조건의 데이터들 혹은 하나의 데이터에 대한 정보를 받아올 때 적절함

 

3. Query string

• ex) api/resource/?name=" "&age=" "

key=value로 이루어져있고, &으로 연결함

filtering, sorting, searching에 적절함

 

4. Body

 {       
   "name": "kim",
   "age": 10
 }

 

URL에는 보이지 않는 오브젝트 데이터(JSON)을 담음

POST를 사용하여 request body안에 넣어 보냄

 

 

 

출처 : https://velog.io/@haileeyu21/Session-RESTful-API-%EB%9E%80-Path-parameters-Query-string