[TIL] REST / REST API / RESTful이란? 22/11/16 13일차

- Today I Learned

-  요청 경로를 지정할 urls.py에서 REST에 대한 이해도가 없어 작성할때 작성을
   어떤식으로 해야할지 해당 부분에 대해 알아보고자 한다.

 

 

- REST의 정의
“Representational State Transfer” 의 약자

       표현적으로      상태를   전송

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

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

   자원의 표현: 그 자원을 표현하기 위한 이름
   -> Ex) DB의 영화 정보가 자원일 때, ‘movies’를 자원의 표현으로 정한다.

-  상태(정보) 전달
   데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
   JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
   월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발
   아키텍처의 한 형식
   REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에

   웹의 장점을 최대한 활용할 수 있는

   아키텍처 스타일이다.

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

 

 

 

- REST의 구체적인 개념

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에

Resource(자원)가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다.
웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

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

 

 

 

- 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.구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.
5.PUT, DELETE를 사용하지 못하는 점
6.pushState를 지원하지 않는 점

  *pushState 함수는 브라우져의 방문 기록을 추가하는 함수다.

- REST가 필요한 이유

 1. ‘애플리케이션 분리 및 통합’
 2. ‘다양한 클라이언트의 등장’
 3. 최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도
     통신을 할 수 있어야 한다.
 4. 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고

     이용하는 방법을모색한 결과, REST에 관심을 가지게 되었다.

 

 

 

 

- REST 구성 요소 ( 자원 , 행위 )

✓ 자원(RESOURCE) - URI

    모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
    자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다. *URI란? 다음글
    Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한

    조작을 Server에 요청한다.

 

✓ 행위(Verb) - HTTP Method

    HTTP protocol의 Method를 사용한다.

     *protocol : "여러 컴퓨터나 단말기 사이에서 데이터 통신을 원활하게 하기 위해

     필요한 "통신 규약"

     HTTP protocol은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.

 

✓ 표현(Representations) = 자원에 대한 표현

    Client가 자원의 상태(정보)에 대한 조작을 요청하면

    Server는 이에 적절한 응답(Representation)을 보낸다.

    REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등

    여러 형태의 Representation(표현)으로 나타내어 질 수 있다.
    JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

 

 

 

 

- REST 특징

1. Uniform (유니폼 인터페이스)
   Uniform Interface는 URI로 지정한 리소스(자원)에 대한 조작을 통일되고
   한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.

2. Stateless (무상태성)
   REST는 무상태성 성격을 갖습니다. 다시 말해 작업을 위한
   상태정보를 따로 저장하고 관리하지 않습니다.
   세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에
    API 서버는 들어오는 요청만을 단순히 처리하면 됩니다.
   때문에 *서비스의 자유도가 높아지고 *서버에서 불필요한 정보를 관리하지 않음으로써
   구현이 단순해집니다.
   *HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.

3. Cacheable (캐시 처리 가능)
   REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에,

   웹에서 사용하는 기존 인프라를 그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능

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

   대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
   캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이

   발생하지 않기 때문에    전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

4. Self-descriptiveness (자체 표현 구조)
   REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도

   이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것입니다.

5. Client - Server 구조
   REST 서버는 API 제공 / 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을

   직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할

   내용이 명확해지고 서로간 의존성이 줄어들게 된다.

  자원을 요청하는 쪽이 Client  (Request)

  자원이 있는 쪽이 Server (Response)

  REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
  Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
  서로 간 의존성이 줄어든다.

6. 계층형 구조(Layered System)

   REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해

   구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

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

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

   *로드밸런싱 : 서버가 처리해야 할 업무 혹은 요청(Load)을

                         여러 대의 서버로 나누어(Balancing) 처리하는 것을 의미한다.

                         한 대의 서버로 부하가 집중되지 않도록 트래픽을 관리해

                         각각의 서버가 최적의 퍼포먼스를 보일 수 있도록 하는 것이 목적이다.

    *캐시: 고비용의 계산 결과를 저장해둠으로써 다음 번에는 실행하지 않아도 되도록.

              1.URL이 오면, 그 페이지를 먼저 캐시에서 찾는다.

              2.캐시에 있다 -> 캐시된 페이지를 보여준다

              3.캐시에 없다 -> 페이지를 가져오고 캐시에 저장하고, 보여준다.

캐시관련 더보기 ↓

장고의 캐시

• 설정은 settings > CACHES에서 한다.

#Memcached

• 메모리 기반 캐시 프레임웍(메모리-캐시: 멤캐시).
• Facebook, 위키피디아에서 디비 접근 줄이기 위해 사용.
• '키-값'쌍으로 메모리에 저장하고 가져온다.
• 데몬(백그라운드로 실행되며, 사용자 인터페이스가 없는 프로그램)으로서 동작, RAM의 특정 용량을 차지.
• 모든 데이터는 메모리에 직접 저장되므로, 데이터베이스 또는 파일 시스템 사용에 오버해드가 없다.
• memcached 바인딩으로는 python-memcached, pylibmc가 많이 쓰임.
• 장점: 여러 서버에서 캐시를 공유할 수 있다. (Memcached 데몬을 여러 머신에서 실행시킬 수 있다.)
• 단점: 캐시된 데이터는 메모리에 저장되기 때문에, 만약 서버에 장애가 발생하면 데이터를 잃게 된다. (임시적으로만 사용해야 함)

#데이터베이스 캐싱

• 캐시 백엔드로 데이터베이스 테이블 사용하기

#파일 시스템 캐싱

• 캐시된 아이템을 파일 시스템에 저장

#지역 메모리 캐싱

• LocMemcache Refer: https://docs.djangoproject.com/ja/1.9/topics/cache/#local-memory-caching

#캐시 인자

• TIMEOUT: 기본은 300초(5분). None으로 하면 캐시 키가 절대 만료되지 않는다.
• OPTIONS: 캐시 백엔드에 전달할 선택사항들. 각 백엔드에 따라 다름.
  • MAX_ENTRIES
  • CULL_FREQUENCY
• KEY_PREFIX: 장고 서버에서 사용되는 모든 캐시 기본 접두어
• VERSION: 장고 서버에 의해 생성된 캐시 키들의 기본 버전 번호

 

출처 : http://milooy.github.io/TIL/Django/django-cache.html#%E1%84%8C%E1%85%A1%E1%86%BC%E1%84%80%E1%85%A9%E1%84%8B%E1%85%B4-%E1%84%8F%E1%85%A2%E1%84%89%E1%85%B5

 

---

 

 

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

 

 

- REST API의 탄생

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

*서버아키텍처란?

  서버가 생성 및 배포되는 서버를 기반으로 한 기본 레이아웃 또는 서버 모델으로 서버 설계 방법로써,

  서버가 생성되는 다른 구성 요소 및 서버가 제공하는 서비스를 의미한다.

 

 

- REST API 디자인 가이드

    REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.

   첫 번째, URI는 정보의 자원을 표현해야 한다 . *URI란?:밑에 설명
   두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

 

- REST API (Resource Naming Best Practices)

- 참고 리소스 원형

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

컨트롤러 : 컨트롤러 리소스는 절차적 개념을 모델링한다. 컨트롤러 리소스는 함수처럼 파라미터, 리턴 값이 있다.

 

 

- REST API 중심 규칙

1. URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)

GET /members/delete/1

 

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

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

 리소스 원형 예시 더보기↓

본문내용 블로그 출처 : https://suhwanc.tistory.com/173

본문내용 블로그 출처 : https://suhwanc.tistory.com/173

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  *route:경로
   Ex) id=12인 student를 삭제하는 route: DELETE /students/12

 

- REST API 설계 규칙

1.슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
   Ex) http://restapi.example.com / houses / apartments
          URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.

2.URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며

   URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
   REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에

   혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
   Ex) http://restapi.example.com / houses / apartments / (X)

 

3.하이픈(- )은 URI 가독성을 높이는데 사용
   불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.

 

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

 

5.URI 경로에는 소문자가 적합하다.
   URI 경로에 대문자 사용은 피하도록 한다.

   RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문

 

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

   *Accept 헤더 * Accept:수용하다.

    Accept 헤더의 경우에는 브라우저(클라이언트) 에서 웹서버로 요청시 요청메시지에 담기는 헤더이다.

   이 Accept헤더는 쉽게 말해 자신에게 이러한 데이터 타입만 허용하겠다는 뜻입니다.

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

 

7. 리소스 간에는 연관 관계가 있는 경우
   /리소스명/리소스 ID/관계가 있는 다른 리소스명
   Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

*참고 응답(Response)상태코드

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

 

---

 

- RESTful이란

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

 

- RESTful의 목적

   이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
   RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라

  일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니,

  성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

 

   RESTful 하지 못한 경우
  Ex) CRUD 기능을 모두 POST로만 처리하는 API
  Ex) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName) *route:경로

 

결론 : 생각보다 정해진 규칙이 많았고 앞으로 장고를 쓸 경우는 해당 컨벤션에 대해

          익숙해져야겠다. 라고 생각이 들었다.

 

 

 

참조 : [번역] REST 리소스 네이밍 가이드

참조 : Django Cache

참조 : REST API 제대로 알고 사용하기

본문내용 출처 : [Network] REST란? REST API란? RESTful이란?