REST API

정유진·2023년 5월 8일

REST(Representational State Transfer)란?

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

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

※자원의 표현 : 그 자원을 표현하기 위한 이름
예) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정함.

※상태(정보) 전달:
데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적

기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일
SERVER-CLIENT 구조
자원이 있는 쪽이 SERVER, 요청하는 쪽이 CLIENT

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

구체적인 개념

HTTP URL(Uniform Resource Identifier)을 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것
=> 즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처
웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URL를 부여
CRUD Operation
    Create : 생성(POST)
    Read : 조회(GET)
    UPdate : 수정(PUT)
    Delete : 삭제(DELETE)
    HEAD : header 정보 조회(HEAD)

장단점

장점

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

단점

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

필요한 이유

‘애플리케이션 분리 및 통합’
‘다양한 클라이언트의 등장’
최근의 서버 프로그램은 다양한 브라우저와 안드로이드폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 함
이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었음

구성요소

자원(resource) - URI

모든 자원에는 고유 ID가 존재하고, 자원은 서버 내에 존재

이 자원을 구별하는 ID가 HTTP URI
예) /groups/:group_id’

클라이언트를 URI를 이용해서 자원을 지정하고 해당 자원의 상태에 대한 조작을 server에 요청

행위(Verd) - HTTP METHOD

HTTP Method 에서 제공하는 GET,POST,PUT,DELETE 등

표현(Representation of Resource)

Client가 자원의 상태에 대한 조작을 요청하면 SERVER는 적절한 응답(Representation)을 보냄

하나의 자원에 대한 응답은 JSON, XML, TEXT, RSS 등 여러 형태가 될 수 있음

JSON 혹은 XML이 가장 일반적인 방식!

특징 (디자인 원칙)

Uniform (유니폼 인터페이스)
요청이 어디에서 오는지와 무관하게, 동일한 리소스에 대한 모든 API 요청은 동일하게 보여야 함.
REST API는 사용자의 이름이나 이메일 주소 등의 동일한 데이터 조각이 오직 하나의 URI(Uniform Resource Identifier)에 속함을 보장해야 함.
리소스가 너무 클 필요는 없지만, 이는 클라이언트가 필요로 하는 모든 정보를 포함해야 함
Stateless (무상태성)
작업을 위한 상태정보를 따로 저장하고 관리하지 않음.
세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됨
때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순
Cacheable (캐시 가능)
가능하면 리소스를 클라이언트 또는 서버측에서 캐싱할 수 있어야 함.
또한 서버 응답에는 전달된 리소스에 대해 캐싱이 허용되는지 여부에 대한 정보도 포함되어야 함
이의 목적은 서버측의 확장성 증가와 함께 클라이언트측의 성능 향상을 동시에 얻는 것
Self-descriptiveness (자체 표현 구조)
REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것
Client - Server 구조
클라이언트와 서버 애플리케이션은 서로 간에 완전히 독립적이어야 함
클라이언트 애플리케이션이 알아야 하는 유일한 정보는 요청된 리소스의 URI이며, 이는 다른 방법으로 서버 애플리케이션과 상호작용할 수 없음
이와 유사하게, 서버 애플리케이션은 HTTP를 통해 요청된 데이터에 전달하는 것 말고는 클라이언트 애플리케이션을 수정하지 않아야 함.
즉, REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됨
계층형 구조
REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 함.
-> 클라이언트와 서버 애플리케이션이 서로 간에 직접 연결된다고 가정하지 않는 것이 좋음.
통신 루프에는 다수의 서로 다른 중개자가 있을 수 있기떄문에
Code-On-Demand(optional)
REST API는 일반적으로 정적 리소스를 전송하지만, 특정한 경우에는 응답에 실행 코드(예: Java 애플릿)를 포함할 수도 있음
이 경우에 코드는 요청 시에만 실행

API(Application Programming Interface) 란?

API란 클라이언트가 리소스를 요청할 수 있도록 서버측에서 제공된 인터페이스(interface)
이러한 API로 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 함
서버를 개발한다는 것은 API에 대한 마스터 권한이 생기는 것
API와 함께 항상 메뉴얼도 제공되어야 함.
URI를 모르면 클라는 사용할 수 없다.

REST API란?

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

특징

사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있음
REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있음.
=> 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작 가능

설계 기본 규칙

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

URL는 정보를 자원을 표현해야 한다.

resource는 동사보다는 명사를, 대문자 보다는 소문자를 사용
resource의 도큐먼트 이름으로는 단수 명사를 사용해야함.
resource의 컬렉션 이름으로는 복수 명사를 사용해야함.
resource의 스토어 이름으로는 복수 명사를 사용해야함.
Ex) GET /Member/1 → GET /members/1

자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현
1. URL에 HTTP Method가 들어가면 안됨
  Ex) GET /members/delete/1 → DELETE /members/1
2. URL에 행위에 대한 동사 표현이 들어가면 안됨 (즉, CRUD 기능을 나타내는 것은 URL에 사용하지 않음)
  Ex) GET /members/show/1 → GET /members/1
  Ex) GET /members/insert/2 → POST /members/2
3. 경로 부분 중 변화하는 부분은 유일한 값으로 대체 (즉, :id는 하나의 특정 resource를 나타내는 고유값)
  Ex) student를 생성하는 route : POST /students
  Ex) id=12인 student를 삭제하는 route : DELETE /students/12

설계규칙

슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
Ex) http://restapi.example.com/houses/apertments
URL 마지막 문자로 슬래시(/ )를 포함하지 않는다.
URL에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며,
URL가 다르다는 것은 리소스가 다르다는 것이고,역으로 리소스가 다르면 URL도 달라져야한다.
REST API는 분명한 URL를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URL 경로의 마지막에는 슬래시(/ )를 사용하지 않는다.
하이픈(- )은 URL 가독성을 높이는데 사용한다.
불가피하게 긴 URL경로를 사용하게 된다면 하이픈을 사용해 가독성을 높여준다.
밑줄(_ )은 URL에 사용하지 않는다.
밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
URL 경로에는 소문자가 적합하다.
URL 경로에 대문자 사용은 피하도록 한다.
PFC 3986(URL 문법 형식)은 URL 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.
파일확장자는 URL에 포함하지 않는다.
REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URL안에 포함시키지 않는다.
Accep header를 사용한다.
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)
리소스 간에는 연관 관계가 있는경우
/리소스명/리소스 ID/관계가 있는 다른 리소스명
Ex) GET : /users/{userid}/devices (일반적으로 소유 'has'의 관계를 표현할 때)

응답 상태 코드

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

RESTful이란?

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

목적

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상화에서는 굳이 RESTful한 API를 구현할 필요는 없다.

RESTful하지 못한 경우

Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

참고
https://meetup.nhncloud.com/posts/92
https://velog.io/@crosstar1228/CSRESTful-API%EB%9E%80
https://www.ibm.com/kr-ko/topics/rest-apis
https://hanamon.kr/rest-api/

정유진

개발자 준비중입니다.

이전 포스트

컴퓨터 구조

다음 포스트