본문 바로가기
프로그래밍언어/패턴, 알고리즘, 프로토콜

REST API 파라미터

by plog 2024. 5. 19.

REST API?

- REST API 란

REST API란 REST(Representational State Transfer)를 기반으로 만들어진 API를 의미합니다. 

 

- REST란 
HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미합니다.

 

- REST에서 CRUD

Create : 데이터 생성(POST)
Read : 데이터 조회(GET)
Update : 데이터 수정(PUT, PATCH)
Delete : 데이터 삭제(DELETE)

 

- REST API 파라미터 종류

1) header 파라미터

header 파라미터는 보통 인증과 권한 부여 두 가지 목적으로 사용됩니다.

 

2) path 파라미터

path 파라미터는 엔드포인트의 일부입니다.

/test/id/{id}/name/{name}

 

3) query string 파라미터

/test?id=3&name=my

 

4) request body 파라미터

json오브젝트를 request body에 넣어 보내는 방법입니다. 

{	
"id": 1,	
"name": "my"
}

 

댓글