REST API

REST API
Representational State Transfer API

REST API❓

REST API란 REST를 기반으로 만들어진 API를 의미합니다.

이때 REST란 Representational State Transfer의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받은 모든 것을 의미하게 됩니다

---

💡REST

REST의 구성

• 자원 - HTTP URI를 통해 자원을 명시
• 행위 - HTTP METHOD 즉 웹에서 사용하는 CRUD
• 표현 - 자원에 대한 행위의 내용

REST의 구성

1. Server - Client 구조
   REST서버는 API를 제공하고, 클라이언트는 사용자인증 및 컨텍스트 등을 직접 관리하는 구조로 각각의 역할이 확실하게 구분되어 상호 의존성이 줄어들게 되는 구조
2. Layered System(계층화)
   REST 서버는 다중 계층으로 구성될 수 있으며, 네트워크 기반의 중간 매체를 사용할 수 있게 함
3. Uniform (유니폼 인터페이스)
   URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 것
4. Stateless (무상태성)
   작업을 위한 상태정보를 따로 저장하고 관리하지 않는 것. 따라서 API서버는 들어오는 요청만 단순하게 처리함
5. Cacheable (캐시기능)
   HTTP라는 기존 웹 표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있음
6. Self-descriptiveness(자체 표현 구조)
   REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현구조로 이루어져있음

---

들어가기 앞서

DESIGN KEY POINT

1. URI는 정보의 자원을 표현해야한다

2. 자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE)로 표현한다

---

❌REST API 디자인 유의사항❌

1. URI는 동사보단 명사, 대문자보단 소문자를 사용한다

 

2. 자원에 대한 행위는 HTTP Method로 표현한다

GET /members/delete/1 -- X
DELETE /members/1 -- O

 

3. 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다

 

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

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하고, URI가 다르다는 것은 결국 리소스가 다르다는 것이며 이는 URI도 달라져야 함을 의미합니다. 따라서 REST API는 분명한 URI를 지향하는 만큼 혼동을 주지 않도록 URI 마지막 겨오에는 슬래시를 사용하지 않습니다

    http://restapi.example.com/foods/cake/ -- X
    http://restapi.example.com/foods/cake  -- O

5. 하이픈(-)은 URI 가독성을 높이는데 사용한다

 

6. 언더바(_)는 사용하지 않는다(하이픈 권장)

 

7. 파일 확장자는 URI에 포함시키지 않는다

(사용하게 된다면 Accept header 사용할 것)

http://jr.example.com/foods/cake/2/photo.jpg -- X
GET / foods/cake/2/photo HTTP/1.1 Host: jr.example.com Accept: image/jpg -- O

 이 포스팅은 https://meetup.toast.com/posts/92 글과 https://khj93.tistory.com/entry/%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-REST-API%EB%9E%80-REST-RESTful%EC%9D%B4%EB%9E%80 글을 참고하였습니다