[네트워크 정리 01] REST 알기

RESTful API 

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

- REST 기반으로 제공하는 서비스를 RESTful, RESTful API는 REST 시스템을 따르는 서비스의 API 

 

* API란?

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

 

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

 

REST API의 특징

- 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다. - REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.

즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

 

REST API 설계 기본 규칙이 있다.

참고 리소스 원형

- 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
- 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
- 스토어 : 클라이언트에서 관리하는 리소스 저장소

 

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

resource는 동사보다 명사, 대문자보다 소문자를 사용한다.
resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

- Ex) GET /Member/1 -> GET /members/1

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

- URI에 HTTP Method가 들어가면 안된다.
    Ex) GET /members/delete/1 -> DELETE /members/1

- URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
    Ex) GET /members/show/1 -> GET /members/1
    Ex) GET /members/insert/2 -> POST /members/2

- 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
    Ex) student를 생성하는 route: POST /students
    Ex) id=12인 student를 삭제하는 route: DELETE /students/12

(이 부분은 완벽하게 이해하려면 조금 더 예시를 많이 찾아봐야 될 것 같다)

 

1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.

• http://restapi.example.com/users/vipusers

2. URI 마지막 문자로 슬래시(/)를 포함하지 않는다. 

• URI에 포함되는 모든 글자는 유일한 식별자로 사용되야 하며, URI가 다르다는 것은 리소스가 다르다는 것 
• 혼동을 주지 않도록 절대로 마지막에 슬래시를 포함하지 않는다. 
• http://restapi.example.com/users/vipusers/(x)

3. 하이픈(-)은 URI 가독성을 높이는데 사용한다. 

4. 밑줄(_)은 URI에 사용하지 않는다.

5. URI 경로에는 소문자를 사용하도록 한다.

6. 파일 확장자는 URI에 표현하지 않는다.

• REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI에 표시하지 않는다.
• 대신 Accept header를 사용한다.
• Ex) GET / members/soccer/345/photo HTTP/1.1 HOST : restapi.example.com Accept : image/jpg

7. 리소스 간에는 연관 관계가 있는 경우

• /리소스명/리로스 ID/관계가 있는 다른 리소스명 
• Ex) GET : /users/{userid}/devices 

 

 

REST API 설계 예시 

기능	HTTP Method	HTTP URL & BODY
all 회원 정보 조회	HTTP GET	http://www.networkstudy.co.kr/users
select 회원 정보 조회	HTTP GET	http://www.networkstudy.co.kr/users/tomas
회원 정보 검색	HTTP GET	http://www.networkstudy.co.kr/users?query=xxx
회원 등록	HTTP POST	http://www.networkstudy.co.kr/users/tomas{     "name":"tomas" }
회원 삭제	HTTP DELETE	http://www.networkstudy.co.kr/users/tomas
해당 회원 정보 변경	HTTP PUT	http://www.networkstudy.co.kr/users/tomas{     "name":"tomas",    "address":"seoul" }

CRUD	HTTP verbs	Route
resource들의 목록을 표시	GET	/resource
resource 중 하나의 내용을 표시	GET	/resource/:id
resource를 생성	POST	/resource
resource를 수정	PUT	/resource/:id
resource를 삭제	DELETE	/resource/:id

 

 

응답 상태 코드 

1XX : 전송 프로토콜 수준의 정보 교환
2XX : 클라이언트 요청 성공적으로 수행
3XX : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함 
4XX : 클라이언트의 잘못된 요청
5XX : 서버쪽 오류로 인한 상태코드

 

 

이해를 위한 용어정리

- REST : REpresentational State Transfer

- Resource-based : vs SOAP-RPC(https://yoons2owo.tistory.com/19)

 

- 자원 resource : 소프트웨어가 관리하는 모든 것, 잘 정의된 상태와 관계, 표준화된 작동방식과 형식을 가지고 전송되는 문서. 

- 자원의 표현 (Representational) : 자원을 표현하기 위한 이름

- 상태 전달 (State Transfer) : 데이터가 요청되는 시점에서 자원의 상태를 전달하는 것을 의미. 

 

한마디로,

- 효율적이고 안정적이며 확장가능한 분산 시스템을 가져올 수 있는 소프트웨어 아키텍쳐 디자인 제약의 모음

- www(월드와이드웹) 과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍쳐에 의한 형식

- REST 는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일이고 이를 적용한 API

- 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나 

- JSON, XML를 통해 데이터를 주고받는 것이 일반적이다.

- 자원기반의 구조(ROA) 설계의 중심에 Resource가 있으며, HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐

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

: 웹사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

 

* CRUD Operation

Create 생성 POST

Read 조회 GET

Update 수정 PUT

Delete 삭제 DELETE

 

 

 

REST의 장단점

장점

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

단점

1. 표준이 존재하지 않는다.
2. 사용할 수 있는 메소드가 4가지 밖에 없다. : HTTP Method 형태가 제한적이다.
3. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
4. 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다(PUT, DELETE를 사용하지 못하는 점, pushState를 지원하지 않는 점)

*pushState : 현재 주소를 다른 것으로 변경(주소창의 url 변경)하면서 페이지가 전환, 갱신되는 것을 방지(검색페이지나 pagination을 가진 페이지에서 주로 사용, 비동기식 ajax로 이뤄질 때)

 

 

REST가 왜 필요할까?

- 서버프로그램이 다양한 브라우저, 스마트폰과 같은 모바일 디바이스에서 통신이 가능해야함 : 멀티 플랫폼 지원을 위해 등장했고 서비스 자원에 대한 아키텍쳐를 세우고 이용하는 방법을 모색한 결과 REST 이 필요하다.

 

 

 

REST 구성 요소

1. 자원(Resource): URI (HTTP URI) 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.

자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.

Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

 

2. 행위(Verb) : HTTP Method HTTP 프로토콜의 Method를 사용한다.

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

 

3. 표현(Representation of Resource) : HTTP Message Pay Load Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.

REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.

JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

 

 

REST 특징

*** Server-Client(서버-클라이언트 구조)

자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.

REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.

Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.

서로 간 의존성이 줄어든다.

 

*** Stateless(무상태)

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

Client의 context를 Server에 저장하지 않는다.

즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.

Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.

각 API 서버는 Client의 요청만을 단순 처리한다.

즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.

물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.

Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

 

**** Cacheable(캐시 처리 가능)

웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.

즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다. *캐싱: 자원의 재활용

HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.

캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

 

**** Layered System(계층화)

Client는 REST API Server만 호출한다.

REST Server는 다중 계층으로 구성될 수 있다.

API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.

또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.

PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

 

**** Code-On-Demand(optional)

Server로부터 스크립트를 받아서 Client에서 실행한다. 반드시 충족할 필요는 없다.

 

**** Uniform Interface(인터페이스 일관성)

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.

HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.

특정 언어나 기술에 종속되지 않는다.

 

 

References

• https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
• https://ybdeveloper.tistory.com/76
• https://www.restapitutorial.com/lessons/whatisrest.html
• https://yoons2owo.tistory.com/19