Restful Api란?

😎Restful Api란?

RESTful API (Representational State Transfer) - 표현 상태 전이
분산 하이퍼미디어 시스템을 위한 아키텍처 스타일

 

API(Application Programming Interface)란?

데이터와 기능의 집합을 제공해서 컴퓨터 프로그램간의 상호작용 및 정보 교환이 가능하도록 하는 것.

자원, 행위, 표현으로 구성되어 있다.

 

✅ REST란

1. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시한다.
2. HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 사용한다.
3. 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다.

 

✅ REST 구성 요소

REST는 다음과 같은 3가지로 구성 되어있다.

1. 자원(Resource) : HTTP URI
   
   • 모든 자원에 고유한 id가 존재하고 이 자원은 Server에 존재한다.
   • 자원을 구별하는 ID는 /lists/:list_id와 같은 HTTP URI다
2. 행위(Verb) : HTTP Method
   • HTTP 프로토콜의 Method를 사용한다. (GET, POST, PUT, DELETE)
3. 표현 (Representations) : HTTP Message PayLoad
   • Client가 자원 상태에 대한 조작 요청을 하면 Server는 적절한 응답을 보낸다.
   • REST에서 하나의 자원은 JSON, XML 등 여러 형태의 Representation으로 나타낸다

 

✅ REST의 특징

1. Uniform (유니폼 인터페이스)
   • Uniform Interface는 URI로 지정한 리소스에 대한 조작을
     통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.
2. Stateless (무상태성)
   • REST는 무상태성이다. 즉, 작업을 위한 상태정보를 따로 저장·관리하지 않는다.
     API 서버는 들어오는 요청만을 처리하면 되기 때문에 서비스의 자유도가 높아지고
     서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
3. Cacheable (캐시 처리 가능)
   • REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에
     웹에서 사용하는 기존 인프라를 그대로 활용 가능하다. 따라서 HTTP가 가진 캐싱 기능 적용이 가능하다.
     HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
4. Self-descriptiveness (자체 표현 구조)
   • REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다.
5. Client - Server 구조
   • REST 서버는 API를 제공하고, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을
     직접 관리하는 구조로 각각의 역할이 명확히 구분되기 때문에
     클라이언트와 서버에서 개발해야 할 내용도 명확해지고 의존성이 줄어든다.
6. 계층형 구조
   • REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해서
     구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

✅ REST의 장단점

장점

• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
• HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 활용할 수 있다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능하다.
• Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
• REST API 메시지를 통해 의도하는 바를 명확하고 쉽게 파악할 수 있다.
• 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

• 표준이 존재하지 않기 때문에 정의가 필요하다.
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면
  쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.

 

✅ REST API 예시

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

Bad : http://rest.com/Running
Good : http://rest.com/run

 

2. 마지막에 슬래시 (/)를 포함하지 않는다.

Bad : http://rest.com/test/  
Good : http://rest.com/test

 

3. 언더바 대신 하이픈을 사용한다.

Bad : http://rest.com/test_blog
Good : http://rest.com/test-blog

 

4. 파일확장자는 URI에 포함하지 않는다.

Bad : http://rest.com/photo.jpg
Good : http://rest.com/photo

 

5. 행위(Method)를 포함하지 않는다.

Bad : http://rest.com/delete-post/1  
Good : http://rest.com/post/1

 

 

RestApi는 표준이 없기 때문에

개발 환경에 따라 알맞게 고려되어야 한다.

 

 

 

https://aws.amazon.com/ko/what-is/restful-api/

RESTful API란 무엇인가요? - RESTful API 설명 - AWS