REST란? REST API란? RESTful이란?

REST란? REST API란? RESTful이란?

 

 

 

 

 

 

[작성자의 다른 글 보러가기: 'DML / DDL / DCL / TCL 에 대해 알아보자 (+ DB명령어)']

 

 

---

 

 

개요

 

평상시 REST / REST API / RESTful 이라는 단어를 많이 들어보았을 것이다. 다른 기타 코딩용어처럼 많이 듣기는 하지만 설명하라고 한다면 막연하기만한 이 세가지 단어에 대해 심도있게 알아보고자 피드를 작성해보게 되었다.

 

 

---

 

목차

 

1. REST의 정의

2. REST의 개념

3. REST의 장단점

4. REST API란

5. REST API 설계규칙

6. RESTful이란

 

 

 

 

 

---

 

 

 

# REST의 정의

 

 

REST(Representational State Transfer)

 

• 자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미
• 자원의 표현에 의한 상태 전달
  • 자원 / 자원의표현 이란?
    • 자원: 해당 소프트웨어가 관리하는 모든것
    • 자원의표현: 그 자원을 표현하기 위한 이름
    • ex> DB의 음식 정보가 자원일 때, 'foods'를 자원의 표현으로 정함
  • 상태(정보) 전달이란?
    • 데이터가 요청되어지는 시점에 자원의 상태(정보)를 전달
    • JSON 혹은  XML을 통해 데이터를 주고 받는 것이 일반적
• 기본적으로 웹의 기존 기술과 HTTP프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일
• 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나

 

 

 

 

---

 

 

# REST의 개념

 

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

 

 

 

---

 

 

# REST의 장단점

 

• 장점
  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
  • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  • REST API 메세지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  • 서버와 클라이언트 역할을 명확하게 분리해준다.

 

---

 

• 단점
  • 표준이 존재하지 않음
  • 사용할 수 있는 메소드가 4가지 (HTTP Method) 뿐
  • 구형 브라우저에서 아직 제대로 지원해주지 못하는 부분이 존재
    • PUT, DELETE를 사용하지 못하는 점

 

 

 

 

---

 

 

# REST API란

 

 

API  ( Application Programming Interface ):

 

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

 

 

 

REST API의 정의:

 

• REST 기반으로 서비스 API를 구현한 것
• OpenAPI(누구나 사용할 수 있는 공개된 API)는 대부분 REST API를 제공

 

 

 

 

 

---

 

 

# REST API의 설계 기본 규칙

 

• URI는 자원의 정보를 표시해야 한다.
  • resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
  • resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
  • resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
  • resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
• 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE)로 표현한다.
  • URI에 HTTML Method가 들어가면 안된다  (ex > GET /members/POST/1   <-- 잘못된 예)
  • URI에 행위에 대한 동사 표현이 들어가면 안된다 (CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)                (ex> GET /member/create/1  <-- 잘못된 예)
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다 (즉 :id는 하나의 특정 resource를 나타내는 고유값이다)
  • ex) student를 생성하는 route:    POST/students
  • ex) id= 12인 student를 삭제하는 route: DELETE/students/12

 

---

 

 

# 그 외의 REST API 설계 규칙들

 

• 슬래시 구분자( / ) 는 계층 관계를 나타내는데 사용한다.                                                                                                   (ex> http://restapi.test.com/fruits/apples)
• URI 마지막 문자로 슬래시를 포함하지 않는다.
  • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다. (ex> https://restapi.test.com/fruits/ (x)
• 하이픈 ( - ) 은 URI 가독성을 높이는데 사용
  • 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
• 밑줄 ( _ ) 은 사용하지 않는다.
  • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용 x
• URI 경로에는 소문자가 적합
  • URI경로에 대문자 사용은 피하도록 한다
  • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
• 파일 확장자는 URI에 포함하지 않는다

 

 

REST API 설계 예시

 

CRUD	HTTP  vebs	Route
resource들의 목록을 표시	GET	/resource
resource 하나의 내용을 표시	GET	/resource / :id
resource를 생성	POST	/resource
resource를 수정	PUT	/resource/ :id
recource를 삭제	DELETE	/resource / :id

 

 

 

 

 

 

 

---

 

 

# RESTful의 개념

 

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

 

---

 

 

# RESTful의 목적

 

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

 

 

# RESTful하지 못한 경우

 

• CRUD 기능을 모두 POST로만 처리하는 API
• route에 resource, id 외의 정보가 들어가는 경우 (REST API 설계 규칙에 위반됨)

 

 

 

 

 

 

 

---