REST, REST API, RESTful

박영준·2023년 3월 29일
network
0

Network

목록 보기
1/6

REST

1. 정의

  • “Representational State Transfer”
    자원을 이름(자원의 표현)으로 구분하여, 해당 자원의 상태(정보)를 주고 받는 모든 것

    • 자원의 표현 : DB 에서 학생 정보(데이터)가 자원. 학생을 'student'로 정한 것이 자원의 표현
    • 상태(정보) 전달 : 데이터 요청 시점에서의 정보. 일반적으로 JSON/XML을 통해 주고받음

  • 분산 하이퍼미디어 시스템(월드 와이드 웹(www)...)을 위한 소프트웨어 개발 아키텍처의 한 형식

  • 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하므로, 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일

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

  • HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
    HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것
    → 웹 사이트의 이미지, 텍스트, DB 내용 등...의 모든 자원에 고유한 ID인 HTTP URI를 부여

    참고: URL, URI, URN

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

2. 특징

1) 서버 - 클라이언트 구조

Server
- 자원이 있는 쪽
- REST Server
- API 제공
- 비즈니스 로직 처리/저장을 책임진다

Client
- 자원을 요청하는 쪽
- 사용자 인증이나 context(세션, 로그인 정보) 등...을 직접 관리/책임진다.

이 구조를 통해, 서로 간 의존성을 줄일 수 있다.

2) 무상태 (Stateless)

  • HTTP 프로토콜은 Stateless Protocol이므로, REST 또한 무상태성을 갖는다.

  • Client 의 context를 Server에 저장 X
    → context 정보(세션, 쿠키, 로그인 정보 등..)를 신경쓰지 않아도 되므로, 구현이 단순해진다.

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

    • 각 API Server 는 Client의 요청(request)만을 단순 처리
    • '이전 요청' 과 '다음 요청의 처리' 는 전혀 관계가 없어야 한다.

    → 이는 Server의 처리 방식에 일관성 부여 + 부담 ↓ + 서비스의 자유도 ↑
    (단, 이전 요청이 DB를 수정하여, DB에 의해 바뀌는 것은 허용)

3) 캐시 처리 가능 (Cacheable)

  • 웹 표준 HTTP 프로토콜을 그대로 사용하므로, 웹에서 사용하는 기존의 인프라를 그대로 활용 가능

    • '웹에서 사용하는 기존의 인프라' = 즉, 캐싱 기능을 적용 가능 (HTTP의 특징 中 하나)
      → 캐싱 구현 : HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag 를 이용

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

  • 캐시 사용을 통해, 응답시간 ↓

  • REST Server 트랜잭션이 발생하지 않기 때문에, 전체 응답시간 ↑, 성능 ↑, 서버의 자원 이용률 ↑

4) 계층화 (Layered System)

  • Client는 REST API Server만 호출한다.

  • REST Server 는 다중 계층으로 구성될 수 있다. (즉, '계층 구조' 를 가진다.)

    /boards/1/comments/3
    • API Server는 순수 비즈니스 로직을 수행하고
      그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
    • API Server는 로드밸런싱, 공유 캐시 등...을 통해 확장성 ↑, 보안성 ↑

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

  • @pathvariable 를 사용하자
    참고: Controller 파라미터 타입 - 3. @PathVariable

5) Code-On-Demand(optional)

  • Server로부터 스크립트를 받아서, Client에서 실행
    (단, 반드시 충족할 필요는 없다)

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

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

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

  • 특정 언어나 기술에 종속되지 X

3. 필요성

  • 애플리케이션 분리/통합

  • 다양한 클라이언트의 등장

  • 최근의 서버 프로그램은 다양한 브라우저와 모바일 디바이스(안드로이폰, 아이폰 ...)에서도 통신을 할 수 있어야 한다.

4. 구성 요소

자원 (Resource) : URI

  • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server 에 존재

  • 자원을 구별하는 ID는 HTTP URI(‘/groups/:group_id’ 같은)

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

행위 (Verb) : HTTP Method

  • HTTP 프로토콜의 Method를 사용

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

표현 (Representation of Resource)

  • Client 가 자원의 상태(정보)에 대한 조작을 요청하면, Server는 이에 적절한 응답(Representation)을 보낸다.

  • REST 에서 하나의 자원은 여러 형태의 Representation으로 나타내어 질 수 있다. (JSON, XML, TEXT, RSS 등...)
    → JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적

5. 장단점

장점

  • HTTP 프로토콜의 인프라를 그대로 사용하므로, REST API 사용을 위한 별도의 인프라를 구출할 필요 X

  • HTTP 프로토콜의 표준을 최대한 활용하여, 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.

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

  • Hypermedia API의 기본을 충실히 지키면서 범용성을 보장

  • REST API 메시지가 의도하는 바를 명확하게 나타내므로, 의도하는 바를 쉽게 파악

  • 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화

  • 서버와 클라이언트의 역할을 명확하게 분리

단점

  • 표준이 존재 X

  • 사용할 수 있는 메소드가 4가지 밖에 없다.
    → HTTP Method 형태가 제한적

  • 브라우저를 통해 테스트할 일이 많은 서비스라면, 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.

  • 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재
    (PUT, DELETE를 사용하지 못하는 점. pushState를 지원하지 않는 점 ...)

REST API

1. 정의

API(Application Programming Interface)

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

REST API

  • REST 기반으로 서비스 API를 구현한 것

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

2. 특징

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

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

  • REST API를 제작하면,
    델파이 클라이언트, Java, C#, 웹 등...을 이용해 클라이언트를 제작할 수 있다.

3. 설계

1) 설계 기본 규칙

  1. URL 는 정보의 자원을 표현해야 한다.
    1) 동사보다는 명사
    2) 대문자보다는 소문자
    3) 도큐먼트 이름 : 단수 명사
    4) 컬렉션 이름 : 복수 명사
    5) 스토어 이름 : 복수 명사

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

    1) 단, URI 에 HTTP Method 가 들어가면 X

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

    2) URI 에 행위 동사가 들어가면 X

    GET /members/show/1 -> GET /members/1

    3) 경로 부분 中 변하는 부부은 유일한 값으로 대체(id값 처럼)
    (id=12인 student를 삭제하는 route: DELETE /students/12)

2) 설계 규칙

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

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

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

  3. 불가피하게 긴 URI경로를 사용할 경우, 하이픈(- )은 URI 가독성을 높이는데 사용

  4. 가독성을 위해, 밑줄(_ )은 URI에 사용하지 X

  5. URI 경로에는 대문자보다는 소문자가 적합
    (RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문)

  6. 파일확장자는 URI에 포함하지 X

    http://restapi.example.com/members/soccer/345/photo.jpg (X)

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

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

    GET : /users/{userid}/devices

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

RESTful

1. 정의

  • REST를 REST답게 쓰기 위한 방법
    (누군가가 공식적으로 발표한 것은 X)

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

2. 필요성

  • 이해하기 쉽고 사용하기 쉬운 REST API를 만들기 위해

  • 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이므로,
    성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

참고: [Network] REST란? REST API란? RESTful이란?
참고: REST API란 무엇이며 다른 유형과 어떻게 다른가요?

profile
박영준
개발자로 거듭나기!
다음 포스트

URI, URL, URN

0개의 댓글