Representational State Transfer의 약자로
자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것
즉 자원(Resource)의 표현(Representation)에 의한 상태 전달
자원의 표현
자원 : 해당 소프트웨어가 관리하는 모든 것
자원의 표현 : 그 자원을 표현하기 위한 이름
상태(정보) 전달
데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달
JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적
월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한
소프트 웨어 개발 아키텍처의 한 형식
REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에
웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일
REST는 네트워크 상에서 Client와 server 사이의 통신 방식 중 하나
API(Application Programming Interface)란
데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용 촉진,
서로 정보 교환 가능하도록 하는 것
(데이터와 클라이언트를 이어주는 중간다리 역할)
REST API의 정의
REST 기반으로 서비스 API를 구현한 것
(DB에 저장된 데이터를 조회하여 가져오는 것 -> 데이터 출력)
누구나 사용할 수 있도록 공개된 'OpenAPI'와 하나의 큰 애플리케이션을 여러 개의 작은
애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처 '마이크로 서비스'
등을 제공하는 업체 대부분은 REST API를 제공한다
참고 리소스 원형
- 도큐먼트 : 객체 인스턴트나 테이터베이스 레코드와 유사한 개념
- 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
- 스토어 : 클라이언트에서 관리하는 리소스 저장소
GET /Member/1 -> GET /members/1
GET /members/delete/1 -> DELETE /members/1
GET /members/show/1 -> GET /members/1
GET /members/insert/2 -> GET /members/2
http://restapi.example.com/houses/apartments
http://restapi.example.com/houses/apartments/ (X)
하이픈(- )은 URI 가독성을 높이는데 사용
불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다
밑줄(_ )은 URI에 사용하지 않는다
밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다
URI 경로에는 소문자가 적합
URI 경로에 대문자 사용은 피하도록 한다
RFC 3986(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)
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
참고 응답상태코드
- 1xx : 전송 프로토콜 수준의 정보 교환
- 2xx : 클라이언트 요청이 성공적으로 수행됨
- 3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
- 4xx : 클라이언트의 잘못된 요청
- 5xx : 서버쪽 오류로 인한 상태코드
RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어
‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다
REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭
이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다
Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateNam