[CS, WEB, HTTP] RESTful API란?(API, REST API, RESTful API)

 

RESTful API

나는 RESTful API를 api를 개발하는 데에 있어서 "예상 가능한 개발을 위한, 개발자들 간의 약속"이라고 이해했다.

실제로 RESTful API는 기존의 SOAP이 프로토콜로써 개발자 간의 약속을 표준화시킨 것과 다르게, 기존에 존재하는 HTTP 프로토콜의 메서드를 기반으로 하는 "아키텍처"이다.

---

API란?

 📌 애플리케이션 프로그래밍 인터페이스(API)는 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 정의

REST란?

📌 Representational State Transfer(REST): API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처

• 인터넷과 같은 복잡한 네트워크에서 통신을 관리하기 위한 지침으로 만들어짐
• REST 기반 아키텍처를 사용하여 대규모의 고성능 통신을 안정적으로 지원할 수 있음
• 쉽게 구현하고 수정할 수 있어 모든 API 시스템을 파악하고 여러 플랫폼에서 사용할 수 있음

REST 구성 요소

1. 자원(Resource) : HTTP URI
2. 자원에 대한 행위(Verb) : HTTP Method
3. 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

RESTful API란?

📌 두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스
REST 아키텍처 스타일을 따르는 API를 REST API라고 하며, REST 아키텍처를 구현하는 웹 서비스를 RESTful 웹 서비스라고 함

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

REST 아키텍처 스타일

균일한 인터페이스

1. 요청은 리소스를 식별해야 함
2. 클라이언트는 원하는 경우 리소스를 수정하거나 삭제하기에 충분한 정보를 리소스 표현에서 가지고 있으며, 서버는 리소스를 자세히 설명하는 메타데이터를 전송하여 이 조건을 충족
3. 클라이언트는 표현을 추가로 처리하는 방법에 대한 정보를 수신
   1. 이를 위해 클라이언트가 리소스를 적절하게 사용할 수 있는 방법에 대한 메타데이터가 포함된 명확한 메시지를 전송
4. 클라이언트는 작업을 완료하는 데 필요한 다른 모든 관련 리소스에 대한 정보를 수신
   1. 이를 위해 서버는 클라이언트가 더 많은 리소스를 동적으로 검색할 수 있도록 표현에 하이퍼링크를 넣어 전송

무상태

• 클라이언트는 임의의 순서로 리소스를 요청할 수 있으며 모든 요청은 무상태이 거나 다른 요청과 분리됨
  • 서버가 매번 요청을 완전히 이해해서 이행할 수 있음을 의미

계층화 시스템

• 클라이언트는 클라이언트와 서버 사이의 다른 승인된 중개자에게 연결할 수 있으며 여전히 서버로부터도 응답을 받음
• 서버는 요청을 다른 서버로 전달할 수도 있음
• 클라이언트 요청을 이행하기 위해 함께 작동하는 보안, 애플리케이션 및 비즈니스 로직과 같은 여러 계층으로 여러 서버에서 실행되도록 RESTful 웹 서비스를 설계할 수 있으며, 이러한 계층은 클라이언트에 보이지 않는 상태로 유지됨

캐시 가능성

• 서버 응답 시간을 개선하기 위해 클라이언트 또는 중개자에 일부 응답을 저장하는 프로세스인 캐싱을 지원
• RESTful 웹 서비스는 캐시 가능 또는 캐시 불가능으로 정의되는 API 응답을 사용하여 캐싱을 제어

온디맨드 코드

• 서버는 소프트웨어 프로그래밍 코드를 클라이언트에 전송하여 클라이언트 기능을 일시적으로 확장하거나 사용자 지정할 수 있음
  • ex) 웹 사이트에서 등록 양식을 작성하면 브라우저는 잘못된 전화번호와 같은 실수를 즉시 강조 표시

REST의 장단점

장점

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

단점

• 표준이 자체가 존재하지 않아 정의가 필요하다.
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
• 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)

REST API 설계 예시

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

Bad Example <http://khj93.com/Running/Good> 
Example  <http://khj93.com/run/>

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

Bad Example <http://khj93.com/test/>  
Good Example  <http://khj93.com/test>

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

Bad Example <http://khj93.com/test_blog>
Good Example  <http://khj93.com/test-blog>

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

Bad Example <http://khj93.com/photo.jpg>  
Good Example  <http://khj93.com/photo>

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

Bad Example <http://khj93.com/delete-post/1>  
Good Example  <http://khj93.com/post/1>

참고자료

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

https://meetup.nhncloud.com/posts/92

https://velog.io/@formroller/Java-정적static-변수와-메소드