RESTful API란

🤔 RESTful API이란?

RESTful API는 두 컴퓨터 시스템이 인터넷을 통해 정보를 안정하게 교환하기 위해 사용하는인터페이스이다.

RESTful API는 안전하고 신뢰할 수 있으며 효율적인 소프트웨어 통신 표준을 따르므로 정보 교환을 지원한다!

 

🧐 REST의 정의

REST(REpresentational State Transfer)는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다. 자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미한다. 즉, 자원(resource)의 표현(representation)에 의한 상태 전달(state transfer)을 뜻한다.

REST는 기존의 웹 기술과 HTTP 프로토콜을 그대로 활용하여 웹의 장점을 최대한 활용할 수 있게 한다.

 

REST의 핵심 개념

1. 자원(Resource): 소프트웨어가 관리하는 모든 것. 예를 들어 문서, 이미지, 데이터베이스의 정보들이 자원에 해당한다
2. 자원의 표현(Representation): 자원을 식별하기 위한 이름이다. 예를 들어, 데이터베이스에서 학생 정보를 관리할 때, 'students'가 자원의 표현이 될 수 있다.
3. 상태(정보) 전달: 클라이언트가 서버에 요청을 보낼 때, 서버는 요청 시점의 자원 상태(정보)를 JSON 또는 XML과 같은 형식으로 전달한다.

REST API 와 RESTful 웹 서비스 

• REST API : REST 아키텍쳐 스타일을 따르는 API
• RESTful 웹 서비스 : REST 아키텍처를 구현한 웹 서비스
• RESTful API: RESTful 웹 API와 같은 의미로 사용되며, REST API와 같은 의미로도 쓰일 수 있다.

REST는 네트워크에서 클라이언트와 서버가 데이터를 주고받는 효율적은 방법을 제공하며, 웹 서비스 설계에서 많이 사용된다.

 

REST 설계  원칙

1. 중심의 설계

• 모든 데이터를 자원으로 취급: 웹 사이트의 이미지, 텍스트, 데이터베이스 내용 등 모든 정보를 하나의 자원으로 간주
• 고유한 식별자 부여: 각 자원은 고유한 식별자(URI)를 가지며, 이를 통해 자원을 구별하고 접근한다.

2. HTTP 메서드를 통한 자원 조작

• 자원에 대한 CRUD 연산: HTTP 메서드 (GET,POST,PUT,DELETE 등)를 사용하여 자원에 대한 생성, 읽기, 수정, 삭제와 같은 다양한 작업을 수행
• URI와 메서드의 조합: 특정URI에 대한 HTTP 메서드를 호출하여 원하는 작업을 지정한다.

REST 구성요소

1. 자원(Resource) - URI

• 모든 자원에는 고유한 id가 존재하고, 이 자원은 server에 존재한다.
• 자원을 구별하는 id는 '/exgroups/:exgroups_id' 와 같은 HTTP URI다
• Client는 URI를 통해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작은 server에 요청한다.

2. 행위(Verb) - Method

• HTTP 프로토콜의 Method를 사용한다.
• HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공한다.(CRUD)

GET	Read: 정보 요청, URI가 가진 정보를 검색하기 위해 서버에 요청한다
POST	Create: 정보 입력, 클라이언트에서 서버로 전달하려는 정보를 보낸다
PUT	Update: 정보 업데이트, 주로 내용을 갱신하기 위해 사용한다 (데이터 전체를 바꿀 때)
PATCH	Update: 정보 업데이트, 주로 내용을 갱신하기 위해 사용한다 (데이터 일부만 바꿀 때)
DELETE	Delete: 정보 삭제, (안전성 문제로 대부분 서버에서 비활성화 한다)

 

3. 표현(Respresentation of Resource)

• Client와 server가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이 있다.
• JSON, XML을 통해 데이터를 주고 받는 것이 일반적이다.

ex) 

• 게시글 목록 조회: GET /posts
• 특정 게시글 조회: GET /posts/12
• 새로운 게시글 생성 : POST /posts
• 게시글 수정: PUT /posts/12
• 게시글 삭제: DELETE /posts/12

REST는 웹 자원을 관리하는 일관되고 간단한 방법을 제공하며, HTTP 프로토콜의 장점을 최대한 활용한다.

핵심개념

• 자원(Resource): 웹 상의 모든 데이터
• URI(Uniform Resoucre Identifier): 자원을 식별하는 고유한 주소
• HTTP Method: 자원에 대한 CRUD 연산 수행 (GET,POST,PUT,DELETE등)

REST API 설계 기본 규칙

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

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

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

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

• URI에 HTTP Method가 들어가면 안된다
  ex) GET /members/delete/1 X => DELETE /members/1 O
• URI에 행위에 대한 동사 표현이 들어가면 안된다 (즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다)
  ex) GET /members/show/1 X => GET /members/1 O
  ex) GET /members/insert/2 X => POST /members/2 O
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다. (즉, :id는 하나의 특정 resource를 나타내는 고유값이다)
  ex) student를 생성하는 route:POST / students
  ex) id가 12인 student를 삭세하는 rout: DELETE /students/12

 

REST의 특징

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

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
  • REST Server는 API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다
  • Client는 사용자 인증이나 context(세션, 로그인 정보)등을 직접 관리하고 책임진다.
  • 역할을 확실히 구분시킴으로써 서로 간의 의존성을 줄인다.

2. Stateless(무상태)

• HTTP 프로토콜은 Stateless Protocol이므로 REST역시 무상태성을 갖는다.
• Client의 context를 server에 저장하지 않는다.
  즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
• Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
  • 각 API 서버는 Client 요청만을 단순 처리한다.
    즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.( DB에 의해 바뀌는 것은 허용)
  • Server의 처리 방식에 일관성을 부여하기 때문에 서비스의 자유도가 높아진다.

3. Cacheable (캐시 처리 기능)

• 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
  즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified Tag 또는 E-Tag를 이용해 캐싱을 구현한다.
• 대량의 요청을 효율적으로 처리할 수 있다.

4. Layered System (계층 구조)

• Client는 REST API Server만 호출한다.
• REST Server는 다중 게층으로 구성될 수 있다.
  • 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있다.
  • Proxy, Getway와 같은 네트워크 기반의 중간매체를 사용할 수 있다.
    하지만 Client는 Server와 직접 통신하는지, 중간 서버와 통신하는지 알 수 없다.

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

• URI로 지정한 Resource에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미한다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하며, Loosely Coupling(느슨한 결함) 형태를 갖는다.
  즉, 특정 언어나 기술에 종속되지 않는다.

6. Self- Descriptiveness (자체 표현)

• 요청 메세지만 보고도 쉽게 이해할 수 잇는 자체 표현 구조로 되어있다.

REST의 장단점

장점

• 간단하고 직관적인 인터페이스 : HTTP 프로토콜을 사용하여 이해하기 쉽고, 표준화된 방법으로 자원을 관리한다.
• 확장성이 좋음: 새로운 자원을 추가하거나 변경하기가 용이하며, 시스템이 커지더라도 유연하게 대응할 수 있다.
• 다양한 플랫폼에서 지원: 웹 환경에서 널리 사용되는 HTTP 프로토콜을 기반으로 하므로, 다양한 프로그래밍 언어와 플랫폼에서 지원된다.
• 캐싱 효율성: HTTP 프로토콜의 캐싱 매커니즘을 활용하여 서버 부하를 줄이고 응답 속도를 향상시킬 수 있다.
• 분산 시스템에 적합: 각 자원이 독립적으로 관리되므로, 분산 시스템 환경에서도 잘 작동한다.

단점

• 과도한 요청: 복잡한 작업을 수행하기 위해 여러번의 HTTP 요청이 필요할 수 있다.
  이는 네트워크 트래픽을 증가시키고 응답 시간을 늘릴 수 있다.
• HTTP 메서드의 제한 :HTTP 메서드(GET,POST,PUT,DELETE 등)가 제공하는 기능이 제한적일 수 있다. 복잡한 작업을 수행하기 위해서는 추가적인 HTTP 헤더나 URL 파라미터를 사용해야 할 수 있다.
• 하이퍼미디어의 부재: REST는 하이퍼미디어를 강조하지 않기 때문에, 클라이언트가 서버의 구조를 미리 알고 있어야 한다. 이는 시스템이 복잡해질수록 유지보수가 어려워질 수있다.
• 오버 엔지니어릴: 간단한 시스템에 REST를 적용하는 것은 오버 엔지니어링이 될 수 있다.

 

✅ RESTful의 목적

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

1. RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API이해도 및 호환성을 높이는것이 주 동기이다. 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요 x

RESTful 하지 못한 경우

1. CRUD 기능을 모두 POST로만 처리하는 API
2. route resource, id 외의 정보가 들어가는 경우 
   ex) /students/updateName

 

🤔 REST API의 특징과 설계 기본 규칙

API (Application Programming Interface)란

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

최근 *OpenAPI, *마이크로 서비스등을 제공하는 업체 대부분은 REST API를 제공한다.

 

*OpenAPI : 누구나 사용할 수 있도록 공개된 API (구글 맵, 공공데이터 등)

*마이크로 서비스 : 하나의 큰 애플리케이션을 여러개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍쳐 

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

 

REST API 설계 규칙 세부사항 

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

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

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

• 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를 사용한다
  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 /user/{userid}/devices (일반적으로 'has'의 관계를 표현할 때)

 

이번에 정리하면서 헷갈리던 URL과 URI의 차이점도 확실히 알았다.

 

 

참고

[간단정리] REST, REST API, RESTful 특징

RESTful API란 무엇인가요?