Fastapi - RESTful API 설계 공부

RESTful 하게 API를 설계해야한다. 라는 말을 항상 들어왔지만 정확하게 어떤 설계가 RESTful 한걸까 하는 궁금증에 찾아보고 정리하게 되었다. 

 

먼저 REST가 있다. 

 

REST(Representation State Transfer) - 자원 상태 전달

 

REST ( Representational State Transfer )

- World Wide Web 아키텍처의 설계 및 개발을 안내하기 위해 만들어진 소프트웨어 아키텍처 스타일 입니다 

- REST는 웹과 같은 인터넷 규모 분산 하이퍼미디어 시스템 의 아키텍처가 어떻게 작동해야 하는지에 대한 일련의 제약    조건을 정의합니다.

                                                                                                                                  출처 : wikipedia

 

 

REST는 자원을 이름(자원의 표현)으로 구분해 해당 자원의 상태(정보)를 주고받는 모든 것을 의미합니다.
자원(resource)의 표현(representation)에 의한 상태 전달을 뜻합니다.

 

자원 : 해당 소프트웨어가 관리하는 모든 것 - 문서, 그림, 데이터 등

표현 : 그 자원을 표현하기 위한 이름 - 유저의 정보는 users라고 표현 

상태 전달 : 데이터가 요청되는 시점에 자원의 상태를 전달한다. - json, xml 등 

---

REST는 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일

- 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용

 

 

REST 구성 요소 - 상세

 

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

2.  HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation 적용

 

가. 자원(Resource): URI

• 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
• HTTP URI로 자원을 구별한다.
• Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

나. 행위(Verb): HTTP Method

• HTTP 프로토콜의 Method를 사용한다.
• HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다.

다. 표현(Representation of Resource)

• Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
• REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태로 표현할 수 있다.
• 보통, JSON 혹은 XML를 통해 데이터를 주고받는 것이 일반적이다.

 

 

 

1) URI or URL? 

두 주소는 모두 index.html을 가리키고 있다.

 

첫 번째 주소는 웹서버의 실제 파일 위치를 나타내는 주소이므로 URI이면서 URL이다.
두 번째 주소는 실제로 index라는 파일이 웹서버에 존재하지 않으므로 URL은 아니다. 하지만 서버 내부에서 이를 처리하여 결국 index.html을 가리키기 때문에 URI라고 볼 수 있다.

 

 

2) CRUD Operation?

 

Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD: header 정보 조회(HEAD)

 

REST의 특징

 

1. Server-Client(서버-클라이언트 구조)
   - 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
         REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
         Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   - 서로 간 의존성이 줄어든다.

2. Stateless(무상태)
   - HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.

   - Client의 context를 Server에 저장하지 않는다.
        세션과 쿠키와 같은 context 정보를 신경 쓰지 않아도 되므로 구현이 단순해진다.

   - Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
        각 API 서버는 Client의 요청만을 단순 처리한다.
        이전 요청이 다음 요청의 처리에 연관되어서는 안 된다.
        물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
        Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

 

 

3. Cacheable(캐시 처리 가능)
        웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
        HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
        HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
        대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
        

        캐시 사용을 통해 응답 시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답 시간, 성능, 서

        버의 자원 이용률을 향상할 수 있다.

4. Layered System(계층화)
        Client는 REST API Server만 호출한다.
        REST Server는 다중 계층으로 구성될 수 있다.
        API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여

       구조상의 유연성을 줄 수 있다.
        또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
        PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

5. Code-On-Demand(optional)
        Server로부터 스크립트를 받아서 Client에서 실행한다.
        반드시 충족할 필요는 없다.

6. Uniform Interface(인터페이스 일관성)
        URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
        HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
        특정 언어나 기술에 종속되지 않는다.

 

 

 

 

API란? 

데이터와 기능의 집합을 제공하여 컴퓨터 프로그램 간 상호작용을 촉진하며, 서로 정보를 교환 가능하도록 하는 것

 

 

그렇다면 RESTAPI란?

- REST 기반으로 서비스 API를 구현한 것
- 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.

 

이러한 REST의 원리를 따르는 API를 RESTful한 API라고 한다.