[네트워크] Rest API

kcm dev blog·2021년 8월 12일

CS 스터디

목록 보기

2/4

REST API Model

REST(Representational State Transfer)
: 아키텍처의 제약 조건을 준수하는 애플리케이션 프로그래밍 인터페이스

리소스를 다룰때 인터페이스에서 정의한 방식으로만 다룰 수 있다는 의미이다.

API(Application Programming Interface)
: 애플리케이션 소프트웨어를 구축하고 통합하는 정의 및 프로토콜 세트

사용자와 클라이언트가 얻으려 하는 리소스 사이의 조정자라고 할 수 있다.

클라이언트의 시스템과 상호작용하여 정보를 검색하거나 기능을 수행하고자 할 때, API를 통해 요청사항을 전달 함으로써 시스템이 요청을 이해하고 응답할 수 있다.

HTTP의 주요 저자중 한명인 로이 필딩(Roy Fielding)은 많은 사람들이 웹 설계의 우수성을 이해하지 못한채 사용하고 있던게 아쉬워 웹의 장점을 최대한 활용할 수 있는 아키텍처로 REST라는 개념을 제안하였다.

REST는 프로토콜이나 표준이 아닌 아키텍처 원칙!

Uniform Interface
:URI로 지정한 리소스를 인터페이스를 통해서만 조작하는 아키텍처 스타일을 사용한다
Stateless
: state(상태)를 저장하지 않는다. 상태를 저장하지 않으므로 서버에게 주는 부담을 줄일 수 있다.
Cacheable
: HTTP라는 웹 표준을 쓰기 때문에 웹에서 지원하는 캐싱 기능을 사용할 수 있다.
Self-descriptiveness(자체표현구조)
: 표현(REST API 메시지)만 보고도 어떤 요청인지 이해할 수 있다.
Client-Server 구조
: 서버와 클라이언트의 역할이 명확하다. 따라서 서로간에 의존성이 줄어든다.
계층형 구조
: 다층으로 구성할 수 있기 때문에 보안, 암호화 계층을 별도로 추가할 수 있고, proxy, gateway 같은 네트워크 기반의 중간매체도 이용할 수 있다.

다음 규칙들을 따르는 API를 RESTful API라고 한다

: 리소스 '자체'와 리소스에 대한 '행위'를 분리하여 설계해야 한다

GET /Users/1 (O)

-> 리소스이름은 주로 명사를 사용한다

GET /Users/update/1 (X)

-> URI는 리소스 자체 위주로 표기해야한다. 리소스에 대한 행위 를 표현하면 안된다!

/는 계층 관계를 나타내는데 만 사용한다
URI의 마지막에는 /를 사용하지 않는다.
리소스명의 가독성을 높이기 위해 -을 사용할 수 있다
(단, _는 사용하지 않는다)
URI에 대문자 사용은 지양한다.
-> 웹에서 대소문자를 구분하기 때문이다
-> RFC3986(URI 문법 형식)에서도 URI스키마와 호스트를 제외하고는 대소문자를 구별해서 사용하라고 규정하고 있다)
Collection, Document 개념의 리소스 사용시 단/복수를 구분하여 사용한다

ex) 
collection(document의 집합): books
document: history

GET : https://this.is.rest-api.com/library/books/history/1

자세한 상태 코드 내용은 MDN: 상태 코드에서 확인할 수 있다.

URI (Uniform Resource Identifier) : 네트워크 상에 존재하는 자원을 구분하는 식별자(ID)로서 의미가 강하다.
URL (Uniform Resource Locator) : 네트워크 상에 존재하는 자원의 위치를 말합니다. 즉 자원의 어디에 있는지 나타내는 Where의 개념
URN (Uniform Resource Name) : 자원의 이름을 나타내는 말이다. 즉 자원이 무엇인지를 말하는 What의 개념으로 이해할 수 있다. URN은 서로 중복되지 않는 유일한 값이어야 한다.