REST API 란 REST API & RESTful API

 

REST API 란

 

---

REpresentational State Transfer 의 약자이고, 자원을 이름으로 구분해 자원의 정보를 주고 받는 모든 것 입니다. 

 

• 자원(Resource)의 표현(Representation)에 의한 상태 전달을 뜻합니다. 
  • 여기서 자원은 해당 소프트웨어가 관리하는 모든 것 (문서, 그림, 데이터, 해당 소프트웨어 자체 등) 
  • 표현은 그 자원을 표현하기 위한 이름이고 
  • 상태 전달은 데이터가 요청되는 시점에 자원의 상태를 전달합니다. 

• 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지 추론이 가능한 것 입니다. 
• 디자인 시 가장 중요한 것은 
  • URI는 정보의 자원을 표현해야 한다.
  • 자원에 대한 행위는 HTTP Method (GET, POST, PATCH, DELETE)로 표현해야한다. 

 

< REST API 설계 규칙 >

 

1. URI는 명사를 사용할 것 (동사를 사용해서는 안된다. 예를 들어 searchUsers, getMember, updateMember, deleteMember 등..)

 

2. 슬래시( / )로 계층 관계를 표현한다.

 

3. URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.

 

4. 밑줄( _ )을 사용하지 않고 하이픈( - )을 사용한다.

 

5. URI는 소문자로만 구성한다.

 

6. HTTP 응답 상태 코드 사용 (클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등 피드백을 받아야한다) 

 

7. 파일확장자는 URI에 포함하지 않는다. (예를 들어 https://sr-dev.tistory.com/image.png <- x )

 

 

 

RESTful API 란 

---

REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful API 라고 합니다. 

 

 

REST의 원리를 잘 지켜서 만든 API는 요청을 보내는 주소만으로 어떤 요청인지 알 수 있습니다.