[WEB] REST API

📝 REST

REST(Representational State Transfer) - 자원을 이름으로 구분해 자원의 상태를 주고받는 소프트웨어 아키텍쳐

• HTTP URI(Uniform Resource Identifier)를 통해 자원을 명시

• HTTP Method를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미

💡 CRUD Operation이란?

- Create : 생성 POST

- Read : 조회 GET

- Update : 수정 PUT

- Delete : 삭제 DELETE

⚙️ REST의 구성

1) 자원(Resource) - HTTP URI

• 모든 자원에 고유 ID가 존재하고, 자원은 서버에 존재한다.

2) 행위(Verb) - HTTP Method

• HTTP Protocol의 Method(POST, GET, PUT, DELETE)를 사용한다.

3) 표현(Representation)

• Client가 자원의 상태에 대한 조작을 요청하면 Server는 이에 대한 적절한 응답을 보낸다.

🪄 REST의 원칙

1) 균일 인터페이스(Uniform Interface)

• HTTP 표준만 따르면 어느곳에서도 사용 가능하다.

2) 무상태(Stateless)

• REST는 HTTP Protocol과 역시 무상태성을 갖는다.

• 서버는 상태 정보를 기억할 필요 없이 클라이언트에서 들어온 요청에 대해서만 처리를 하고 응답을 한다.

3) 계층 구조(Layer System)

• Client는 REST API Server만 호출한다.

• REST Server는 다중 계층으로 구성될 수 있는데 이때 Client는 어떤 Server와 통신하는지 알 수 없다.

4) 캐시 가능(Cacheable)

• HTTP 표준을 사용함으로 캐싱 기능을 사용한다. 이에 대해 대량의 요청을 처리할 수 있다.

5) Server-Client

• 자원을 가지고 있는 곳을 Server, 자원을 요청하는 곳을 Client로 하여 각자의 역할을 구분시켜 의존성을 줄인다.

📑 REST API

API(Application Programming Interface) - 다른 소프트웨어 시스템과 통신하기 위한 규칙

💥 REST API란 REST의 특징을 기반으로 서비스 API를 구현한 것

❗ REST API 설계 규칙

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

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

🪄 REST API 설계 가이드

• URI는 명사를 사용한다.
  GET /members (O)
GET /delete (X)

• /를 사용해서 계층 관계를 표현한다.
  GET /members/list (O)

• URI의 마지막 문자에 /를 포함하지 않는다.
  GET /members/1/ (X)
GET /members/1 (O)

• _를 사용하지 않고, -를 사용한다.
  GET /members/list_1 (X)
GET /members/list-1 (O)

• URI는 소문자로만 구성한다.
  GET /Members/List (X)
GET /members/list (O)

• HTTP 응답 상태 코드를 사용한다.
  EX) HTTP Status 200 (Ok)
HTTP Status 404 (Not Found)

• 파일 확장자는 URI에 포함시키지 않는다.(Accept-header를 사용한다.)
  http://example.com/members/list/photo.png (X)
http://example.com/members/list/photo (O)

✅ RESTful

RESTful란 REST의 원칙을 따르는 시스템을 일컷는 단어로 사용된다.

👊 RESTful 목적

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 RESTful의 목적이다.

• 이는 성능 향상에 초점을 맞춘 것이 아니라 이해도 및 호환성에 초점을 맞춘 것이라 항상 RESTful한 API를 고집할 필요는 없다.

❌ RESTful 하지 못하다?

• CRUD 기능을 모두 POST로만 처리하는 API

• REST API의 설계 규칙을 어기는 경우