REST API란

모래·2022년 8월 30일
0

졸업프로젝트

목록 보기
1/9

졸업프로젝트를 하면서 REST API를 사용하게 되면서 이에 대해 내가 보려고 정리함!

1. REST(REpresentationl State Transfer)란?

  • REST는 자원의 이름으로 구분해 해당 자원의 상태를 주고 받는 모든 것
  • 자원표현에 의한 상태 전달

    1. 자원 : 해당 소프트웨어가 관리하는 모든 것 (문서, 그림, 데이터, 해당 소프트웨어 자체 등)
    2. 표현: 그 자원을 표현하기 위한 이름 (DB의 학생 정보가 자원이면, ‘students’를 자원의 표현으로 정함)
    3. 상태 전달: 데이터가 요청되는 시점에 자원의 상태를 전달 (보통 JSON 이나 XML 통해 데이터를 주고 받는 것이 일반적임)

  • REST는 기본적으로 웹의 기존 기술과 http 프로토콜을 그대로 활용하므로 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
  • REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.

1-1. REST의 구체적인 개념

어떤 자원에 대해 CRUD(Create, Read, Update, Delete) 연산을 수행하기 위해 URI(Resource)로 GET, POST 등의 방식(Method)을 사용하여 요청을 보내며, 요청을 위한 자원은 특정한 형태(Representation of Resource)로 표현되는 것이다.

URI와 URL의 차이점
URL은 Uniform Resource Locator로 인터넷 상 자원의 위치를 나타낸다.
URI는 Uniform Resource Identifier로 인터넷 상의 자원을 식별하기 위한 문자열의 구성으로 URI는 URL을 포함하게 된다. URI가 URL보다 포괄적인 범위라고 할 수 있다.

1-2. REST의 구성 요소

1. 자원(Resource) - URI

  • 모든 자원에는 고유한 ID가 존재, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 이다.
  • Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태에 대한 조작을 Server에 요청한다.

2. 행위(Verb) - method

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

3. 표현(Represetnation of Resource)

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

1-3. REST의 특징

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

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

2. Stateless(무상태)

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

3. Cacheable(캐시 처리 기능)

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

4. Layered System(계층 구조)

  • client는 REST API Server만 호출한다.
  • REST Server는 다중 계층으로 구성될 수 있다.
    - API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있음
    • Proxy, Gateway와 같은 네트워크 기반의 중간매체를 사용할 수 있음

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

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

2. REST API 란?

REST 특징을 기반으로 서비스 API를 구현한 것

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

2-1. REST API 특징

각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능하다.

REST API 설계 예시

1. URI는 명사를 사용하고, 소문자로만 구성한다.

Bad Example http://sujin1018.log/Running/
Good Example  http://sujin1018.log/run/

2. 슬래시(/)로 계층관계를 표현하고, 마지막에 슬래시를 포함하지 않는다.

Bad Example http://sujin1018.log/test/
Good Example  http://sujin1018.log/test

3. 언더바(_) 대신 하이픈(-)을 사용한다.

Bad Example http://sujin1018.log/test_log
Good Example  http://sujin1018.log/test-log

4. 파일확장자는 URI에 포함하지 않는다.

Bad Example http://sujin1018.log/photo.jpg
Good Example  http://sujin1018.log/photo

5. 행위를 포함하지 않는다.

Bad Example http://sujin1018.log/delete-post/1
Good Example  http://sujin1018.log/post/1

3. RESTful API 란?

REST의 설계 규칙을 잘 지켜서 설계된 API

REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭한다.

REFERENCE🙇‍♀️

https://dev-coco.tistory.com/97
https://khj93.tistory.com/entry/네트워크-REST-API란-REST-RESTful이란
https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

profile
웹 백엔드 개발자가 되기 위해 열심히 공부를 하자🔥

0개의 댓글