Root(√), 이용훈

Root(√), 이용훈

C++, Java, Python, Software Engineer

2 minute read

REST API

REST(Representational State Transfer) API란

RESTFUL한 API를 말한다. 그렇다면 RESTFUL 하다는 것과 API는 무엇일까?

API(Application Programming Interface)

애플리케이션 소프트웨어를 구축하고 통합하기 위한 정의 및 프로토콜 세트이다. API를 사용하면 구현 방식(예를 들면 하드웨어, 컴퓨터 구조 - GPU, CPU)을 알지 못해도 말 그대로 이 인터페이스를 통해 제품 또는 서비스가 서로 소통할 수 있으며 이를 통해 애플리케이션 개발을 간소화하여 시간과 비용을 절약할 수 있다. 쉽게 말해서 어떤 애플리케이션 또는 하드웨어 등과 소통하기 위한 설명서 같은 것이다.

RESTFUL 하다는 것

REST는 2000년도에 로이 필딩(Roy Fielding)의 박사학위 논문에서 최초로 소개되었다. 로이 필딩은 HTTP의 주요 저자 중 한 명으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 한다.

REST 구성

  • 자원(Resource) - URI
  • 행위(Verb) - HTTP METHOD
  • 표현(Representations)

정보를 주고받을 때 json, XML과 같은 형식은 규정하고 있지 않다.

REST의 특징

  1. Uniform(유니폼 인터페이스)

    URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일

  2. Stateless(무상태성)

    작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 이 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다. 그리고 처음 요청을 서버1에서 처리하고, 그 다음에 서버2에서 요청을 처리해도 어차피 서버는 그 클라이언트에 대한 상태를 저장하지 않았으므로 처리가 간단해진다.

  3. Cacheable(캐시 가능)

    REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능핟. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다.

  4. Self-descriptiveness(자체 계층 구조)

    REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다.

  5. Client-Server 구조

    REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 구분되기 때문에 클라이언트와 서버에서 개발해야할 내용이 명확해지고 서로간의 의존성이 줄어들게 된다.

  6. 계층형 구조

    다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

REST API 설계 시 중요한 항목

  • URI는 정보의 자원을 표현해야 한다. 동사형이 들어가는 것을 지양해야한다.
  • 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

REST API 사용하기 쉽게 만드는 법

REST API를 만들 때는 URL을 어떻게 할 것인지부터 매우 고민되는 부분이다. 뿐만 아니라 어떤 컨벤션을 채택할 것인지, API를 어떻게 단순하게 해서 유지보수할 것인지도 고민해아할 부분이다.

1. Start from a good database design

REST API 자체가 문서를 저장하는 규약이라고 보면되기 때문에 데이터베이스 디자인은 매우 중요하다. -> 데이터 정규화를 잘해야한다!

2. REST endpoint 예시

image-20210601001912413

  • As soon as you want to filter on the data returned by your server, you will be forced to use a syntax that will differentiate the fields of your entities (for example, you want to retrieve only the id of your tasks and your users, you will write something similar to /api/task/{id}?select=task.id,task.user.id), which will make the task of parsing your server-side query strings more complicated

출처

You may also enjoy