RESTful API

RESTful API란

---

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

그리고 RESTful API는 안전하고 신뢰할 수 있으며 효율적인 소프트웨어 통신 표준을 따릅니다.

API
Application Programming Interface는 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 정의

클라이언트
클라이언트는 웹에서 정보에 액세스하려는 사용자
클라이언트는 API를 사용하는 사람이거나 소프트웨어 시스템일 수 있다.

리소스
리소스는 다양한 애플리케이션이 클라이언트에게 제공하는 정보
리소스는 이미지, 동영상, 텍스트, 숫자 또는 모든 유형의 데이터일 수 있으며,
클라이언트에 리소스를 제공하는 시스템을 서버라고도 한다.
 API를 사용하여 리소스를 공유하고 보안, 제어 및 인증을 유지하면서 웹 서비스를 제공한다.

인터페이스
두 애플리케이션 간의 서비스 계약(약속)

 

 

 

 

REST란?

---

Representational State Transfer(REST)는 API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처입니다.

 

REST의 구성

• Representational : 대표
• State : 상태
• Transfer : 전송

 

REST는 처음에 인터넷과 같은 복잡한 네트워크에서 통신을 관리하기 위한 지침으로 만들어졌습니다.

REST 기반 아키텍처를 사용하면 대규모의 고성능 통신을 안정적으로 지원할 수 있습니다.

• REST 아키텍처 스타일을 따르는 API: REST API
• REST 아키텍처를 구현하는 웹 서비스: RESTful 웹 서비스
• RESTful API는 RESTful 웹 API (REST API와 RESTful API라는 용어는 같은 의미로 사용된다.)

 

 

 

 

RESTful API 이점

---

1. 확장성

REST API를 구현하는 시스템은 REST가 클라이언트-서버 상호 작용을 최적화하기 때문에 효율적으로 크기 조정할 수 있습니다.

 

2. 유연성

RESTful 웹 서비스는 완전한 클라이언트-서버 분리를 지원합니다.

각 부분이 독립적으로 발전할 수 있도록 다양한 서버 구성 요소를 단순화하고 분리합니다.

 

3. 독립성

REST API는 사용되는 기술과 독립적입니다.

API 설계에 영향을 주지 않고 다양한 프로그래밍 언어로 클라이언트 및 서버 애플리케이션을 모두 작성할 수 있습니다.

또한 통신에 영향을 주지 않고 양쪽의 기본 기술을 변경할 수 있습니다.

 

 

 

 

RESTful API 작동 방식

---

클라이언트는 리소스가 필요할 때 API를 사용하여 서버에 접속합니다.

서버 애플리케이션 API 문서에서 클라이언트가 REST API를 어떻게 사용해야 하는지 설명합니다.

 

REST API 호출에 단계

1. 클라이언트가 서버에 요청을 전송
   • 클라이언트가 API 문서에 따라 요청 형식을 지정
2. 서버가 클라이언트를 인증하고 해당 요청을 수행할 수 있는 권한이 클라이언트에 있는지 확인
3. 서버가 요청을 수신하고 내부적으로 처리
4. 서버가 클라이언트에 응답을 반환
   • 응답에는 요청 성공 여부 및 클라이언트가 요청한 모든 정보가 포함된다.
     

 

 

 

 

RESTful API 클라이언트 요청에 포함된 내용

---

고유 리소스 식별자

서버는 고유한 리소스 식별자로 각 리소스를 식별합니다.

REST는 URL(Uniform Resource Locator)을 사용하여 리소스를 식별합니다.

URL은 리소스에 대한 경로 지정

URL은 요청 엔드포인트라고도 하며 클라이언트가 요구하는 사항을 서버에 명확하게 지정해야 합니다.

 

메서드

HTTP(Hypertext Transfer Protocol)을 사용하여 RESTful API를 구현합니다.

HTTP 메서드는 리소스에 수행해야 하는 작업을 서버에 알려줍니다.

 

일반적인 HTTP 메서드

GET

클라이언트는 GET을 사용하여 서버의 지정된 URL에 있는 리소스를 액세스(접근)합니다.

GET요청을 캐싱하고 RESTful API요청에 따라 파라미터를 넣고 전송하여 서버에 원하는 데이터를 지시 할 수 있습니다.

액세스
기억 장치에 데이터를 쓰거나 기억 장치에 들어있는 데이터를 탐색하고 읽는 과정
쉽게 말해서 '접근'이라고 생각하면 됩니다.

ex) '누군가가 내 아이디에 액세스했습니다.' → '누군가가 내 아이디에 접속했다 또는 접근했다.'

POST

클라이언트는 POST를 사용하여 서버에 데이터를 전송합니다.

 

PUT

클라이언트는 PUT을 사용하여 서버의 기존 리소스를 업데이트합니다.

 

DELETE

클라이언트 DELETE요청을 사용하여 리소스를 제거합니다.

 

HTTP 헤더

요청 헤더는 클라이언트와 서버 간에 교환되는 메타데이터입니다.

예를 들어, 요청 헤더는 요청 및 응답의 형식을 나타내고 요청 상태 등에 대한 정보를 제공합니다.

 

 

 

 

RESTful API 서버 응답에 포함된 내용

---

상태 표시줄

요청 성공 또는 실패를 알리는 상태 코드가 있다.

2XX 코드는 성공, 4XX 및 5XX 코드는 오류, 3XX 코드는 URL 리디렉션을 나타낸다.

 

일반적인 상태 코드

• 200: 일반 성공 응답
• 201: POST 메서드 성공 응답
• 400: 서버가 처리할 수 없는 잘못된 요청
• 404: 리소스를 찾을 수 없음

메시지 본문

응답 본문에는 리소스 표현이 포함됩니다.

서버는 요청 헤더에 포함된 내용을 기반으로 적절한 표현 형식을 선택합니다.

클라이언트는 데이터 작성 방식을 일반 텍스트로 정의하는 XML 또는 JSON 형식으로 정보를 요청할 수 있습니다.

 

예를 들어, 클라이언트가 John이라는 사람의 이름과 나이를 요청하면 서버는 다음과 같이 JSON 표현을 반환합니다.

'{"name":"John", "age":30}'

 

헤더

응답에는 응답에 대한 헤더 또는 메타데이터도 포함됩니다.

이는 응답에 대한 추가 컨텍스트를 제공하고 서버, 인코딩, 날짜 및 콘텐츠 유형과 같은 정보를 포함합니다.

 

 

참고자료

---

https://aws.amazon.com/ko/what-is/restful-api/

RESTful API란 무엇인가요? - RESTful API 설명 - AWS

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

[Network] REST란? REST API란? RESTful이란? - Heee's Development Blog