나의 개발일지

REST API / CRUD Operation / RESTful 정의 및 특징 본문

카테고리 없음

REST API / CRUD Operation / RESTful 정의 및 특징

heew0n 2024. 3. 13. 15:03

출처 : https://velog.io/@vieowf23r/RESTful-API

 

 

Rest의 정의

Representation State Transfer의 약자

자원의 이름(표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.

 

구체적인 개념은 HTTP URL을 통해 자원(resource)을 명시하고, HTTP Method(post, get, put, delete)를 통해 해당 자원에 대한 CRUD operation*를 적용하는 것을 의미한다. 즉 REST는 자원 기반 구조(ROA) 설계의 중심에 resource가 있고 HTTP Method를 통해  resource를 처리하도록 설계된 아키텍쳐를 의미한다.

 

 

* CRUD Operation
Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD: header 정보 조회(HEAD)

 

REST의 구성

* 자원(Resource) - URL
* 행위(Verb) - Http Method
* 표현(Representations)


1. 자원 (Resource) URL
모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
자원을 구별하는 ID는 /orders/order_id/1 와 같은 HTTP URI 이다.
URI을 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 server에 요청한다


2. 행위 (Verb) - Http Method
HTTP 프로토콜의 Method를 사용한다.
HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다.

3. 표현 (Representaion of Resource)
Client가 자원의 상태 (정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답 (Representation)을 보낸다
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타낼 수 있다.
현재는 JSON으로 주고 받는 것이 대부분이다.

 

 

 

REST API란

클라언트와 서버 간의 두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스


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

 

 


REST API의 정의

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

 

 

 

REST API 설계 규칙

1) 명사, 소문자 => 동사x
2) 명사는 복수형
3) URI 마지막은 / 포함x

   - 슬래시 구분자는 계층관계를 나타내는 데 사용
4) URI는 언더바x 하이픈 사용 (-)

   - 하이픈은 URL 가독성을 높이는 데 사용
5) 파일의 확장자를 표시x

 

 


 

RESTful 하다!

REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭

-> ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.

 

 

RESTful의 목적

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

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

 

 

RESTful 하지 못하는 경우

URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.