rest api

반응형

우리를 괴롭히지만 백엔드 개발자라면 반드시 마주해야 하는

REST와 REST API와 RESTful의 개념을 확실히 알아보자.

 

REST (Representational State Transfer)

 

개념


하나의 URI는 하나의 고유한 리소스를 대표하도록 설계된다는 개념이다.

 

하나의 URI는 하나의 고유한 리소스를 대표하도록 설계!

 

자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미한다.

 

기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에,

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

 

HTTP 통신을 한다는 말.

 

REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다 통신 방식이랍니다. 통신 방식

 

 

TMI


2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었습니다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다.

 

 

사용 이유


HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.

웹 서버+소프트 웨어(설치)가 아니라 웹 서버+REST API가 된다는 말.

 

HTTP 표준 프로토콜이기 때문에 HTTP 통신만 되는 플랫폼이라면

플랫폼의 영향을 받지 않는다.

 

REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.

 

서버와 클라이언트의 명확한 역할 분리.

 

다양한 브라우저 및 모바일 디바이스에서 통신 가능.

 

애플리케이션 분리 및 통합 가능.

 

 

종류


METHOD

역할

POST(Create)

POST를 통해 해당 URI를 요청하면 리소스를 생성합니다.

GET(Read)

GET를 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.

PUT(Update)

PUT를 통해 해당 리소스를 수정합니다.

DELETE(Delete)

DELETE를 통해 리소스를 삭제합니다.

HEAD

Header 정보를 조회(HEAD) 합니다.

 

종류는 무조건 외우는 걸로!

 

 

특징


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

 

자원 요청(Request) Client

-사용자 인증, 세션, 로그인,토큰 정보 등을 관리

 

자원 응답(Response) Server

-API 제공 , 비즈니스 로직 처리 및 저장

 

1-1.Stateless(무상태)

 

HTTP 프로토콜은 *Stateless Protocol이므로

REST 역시 무상태성을 갖는다. (HTTP 프로토콜이니까)

 

*Stateless Protocol (무상태 프로토콜)

 

- 서버와 클라이언트의 이전 통신 상태 (state)를 저장하지 않는 프로토콜  

  - 서버의 현재 상태에 따라 요청 (request)에 대한 응답(response)이 달라질 수 있음

  - 연속된 상태정보를상태 정보를 저장하지 않기 때문에 HTTP는 application 구현 상에서 상태 정보를 저장해야 함 

 

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

(그러므로 할 일이 줄어듬 구현이 단순해짐)

 

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

(이 부분은 Stateless Protocol 설명에 나와있다.)


 

2.Cacheable(캐시 처리 가능)

 

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

-HTTP 캐싱 기능 적용 가능

-HTTP 프로토콜 표준 *Last-Modified 태그나 *E-Tag 이용 캐싱 구현 가능

-대량의 요청을 캐시 사용에 의해 응답 시간 ↑ 성능 ↑ 서버 자원 이용률 ↑ REST Server 트랜잭션 발생 X

동일한 GET 메서드 실행 -> 캐시에서 가져옴 -> 속도 향상

 

*Last-Modified

응답은 HTTP 헤더에 서버가 알고 있는 가장 마지막 수정된 날짜와 시각을 담고 있습니다. 

이미지/CSS/JS와 같은 정적 파일들은 아파치에서 자동적으로 Last-Modified, If-Modified-Since 헤더를 붙여줌

문법

Last-Modified: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT

 

*E-Tag

HTTP 응답 헤더는 특정 버전의 리소스를 식별하는 식별자입니다. 웹 서버가 내용을 확인하고 변하지 않았으면, 웹 서버로 full 요청을 보내지 않기 때문에, 캐시가 더 효율적이게 되고, 대역폭도 아낄 수 있습니다. 하나, 만약 내용이 변경되었다면, "mid-air collions"이라는 리소스 간의 동시 다발적 수정 및 덮어쓰기 현상을 막는데 유용하게 사용됩니다.

 

아파치에서는 이미지/CSS/JS와 같은 정적 파일은 자동으로 ETag 헤더를 붙여줌

 

같은 내용을 보냈으면 캐시로 있던 거 보내고 아니면 데이터 업데이트해준다는 말.


3.Layered System(계층화)

 

3-1.Client는 REST API Server만 호출.

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

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

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

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


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

 

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

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

특정 언어나 기술에 종속 X.

 

 

이제 REST 설명 끝났고…………………….

 

REST API

 

개념


위 내용에서 실컷 설명한 { REST } 기반으로 서비스 API를 구현한 것!

 

 

사용 이유


사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.

REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.

 

계속 반복되는 말

REST는 HTTP 표준 기반 HTTP가 사용되는 데는 모두 다 사용할 수 있다.

 

 

설계 규칙


도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념, 단수 명사를 사용.

컬렉션 : 서버에서 관리하는 디렉터리라는 리소스, 복수 명사를 사용.

스토어 : 클라이언트에서 관리하는 리소스 저장소, 복수 명사를 사용.

 

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

 

Resource

 

동사보다는 명사, 대문자보다는 소문자를 사용.

GET /Member/1 -> GET /members/1

 

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

 

URI에 HTTP Method가 들어가면 안 된다.

GET /members/delete/1 -> DELETE /members/1

URI에 행위에 대한 동사 표현이 들어가면 안 된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)

GET /members/show/1 -> GET /members/1
GET /members/insert/2 -> POST /members/2

경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고윳값이다.)

student를 생성하는 route: POST /students
id=12인 student를 삭제하는 route: DELETE /students/12

 

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

http://restapi.example.com/houses/apartments

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

http://restapi.example.com/houses/apartments/ (X)

 

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

불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.

 

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

밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

 

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

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.

Accept header를 사용한다.

http://restapi.example.com/members/soccer/345/photo.jpg (X)
GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

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

/리소스명/리소스 ID/관계가 있는 다른 리소스명

GET : /users/{userid}/devices

 

RESTful

 

개념


RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.

 

REST API를 제공하는 웹 서비스를 RESTful 하다고 할 수 있다.

 

RESTful은 REST를 REST 답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.

즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다

 

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

 

서드 파티 웹 콘텐츠를 만드는 경우, 그들에게 제공해줄 수 있을 만큼의 REST API를 제공하는 것.


정리

 

REST

1. 로이 필딩이라는 사람이 2000년에 발표함.

2. 하나의 URI 하나의 고유한 리소스를 대표하도록 설계한 개념

3.HTTP 프로토콜을 사용하는 곳이면 사용 가능

4.Server-Client 명 확 히 구분됨

5. 종류는 GET, POST, PUT, DELETE가 있음.


REST API

1.REST 기반으로 만들어진 API

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

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


RESTful

1. 여긴 REST API 제공합니까? 네.라고 할 수 있다면 RESTful

 

다음엔 개념 말고 실제 문법과 사용법에 대해 포스팅하겠습니다.

반응형

+ Recent posts