REST API, RESTful 정의

 

[참조 문헌]

https://mannhowie.com/rest-api

https://medium.com/

 

💡개요

REST는 Representational State Transfer, API는 Application Programming Interface의 약어라고 한다.

 

웹을 통해 클라이언트와 서버 애플리케이션 간 통신 및 데이터 교환을 가능케 하는 도구이다.

 

REST API는 웹 서비스들이 어떻게 통신해야 할지를 정의한 설계 규칙이다. 이를 위해 엔드포인트, 리소스, HTTP 메소드, 요청 및 응답 형식과 상태 코드 등의 정보들을 이용한다. 자원을 JSON, XML 등으로 표현하기 때문에 Representational이라는 수식어가 붙는다.

 

API는 프로그래머들이 서로 다른 소프트웨어 애플리케이션 간 연결할 때 사용하는 도구이다. 기존 프로그램의 특정 기능이나 데이터를 접근할 수 있는 방법을 제공하여, 애플리케이션과 서비스를 개발하는데 편리함을 제공한다.

 

REST API는 확장성 및 유연성을 지닌 웹 서비스를 설계하기 위한 규칙들을 정의한 설계 방식(architectural style)이다.

 

RESTful 웹 서비스는 HTTP 프로토콜 기반으로, HTTP 메소드들로 리소스에 대한 CRUD 연산들을 수행한다.

 

💡REST 특징

 

 

 

REST의 핵심은 다음과 같다.

1. 무상태(Stateless): 클라이언트-서버 통신은 무상태여야 한다. 이는 요청을 처리하기 위해서는 요청마다 필요한 모든 정보가 담겨 있어야 함을 의미한다. 또한, 서버는 요청 간 세션 정보를 유지하지 않는다.

2. Client-Server: 이 둘은 독립적으로 동작하며, 잘 설계된 API를 기반으로 통신한다.

3. Cacheability: 서버의 응답은 캐싱 가능해야 동일 요청에 대해서 이전 응답을 재활용하고 이를 통해 서버 부하를 줄인다.

4. 계층화된 시스템: REST는 계층화된 시스템 아키텍처를 지원해야 한다. 이는 통신 중간 매개체로 프록시나 게이트웨이를 추가하여 성능, 확장성, 보안을 개선할 수 있어야 함을 의미한다.

5. 일관된(Uniform) 인터페이스: 모든 리소스는 일관된 인터페이스로 접근 가능해야 하며, URI로 식별돼야 한다. HTTP 메소드로 리소스에 대한 CRUD 연산을 수행하고, 이에 대한 응답은 JSON이나 XML 같은 일관된 형식을 따라야 한다.

 

💡RESTful API란

API가 RESTful하려면, HTTP 메소드를 용도에 맞게, URI로 리소스를 명시하며, 콘텐츠 협상을 지원하고, 적절한 상태 코드를 반환해야 한다.

 

API가 RESTFUL하면, API가 간결해지고, 직관적이며, 유지보수하기 쉬워진다.

 

개발한 API는 버전과 무관하게 모두 지원 가능해야 한다. 클라이언트가 예전 API로 요청해도 제기능을 해야 한다. 보통, URI 상에 "api/v1/users"처럼 버전 번호를 넣어서 구분한다.

 

API를 문서화해야 개발자들이 올바르게 이해하고 쓸 수 있다. API 엔드포인트, 파라미터, 응답 형식 등이 문서화되어 있어야 한다. Swagger 등의 오픈소스로 문서화를 자동화 할 수 있다.

 

💡REST API 보안

 

 

REST API는 데이터의 보안적인 측면도 고려해야 한다. REST API의 보안은 다음을 이용할 수 있다.

 

Authentication(인증)

REST API를 접근하는 사용자를 검증한다. 보호된 리소스를 접근하기 전, 사용자의 credentials(username과 password)를 검증한다. OAuth2, JWT나 Basic Authentication으로 구현할 수 있다.

 

Authorization

리소스에 대한 권한을 가진 사용자만 접근할 수 있도록 한다. 역할과 권한을 통해 정의할 수 있다. RBAC나 ABAC를 통해 API로 세밀한 접근 권한을 제어할 수 있다.

 

Encryption

REST API 보안의 핵심이다. 클라이언트와 서버 간 모든 데이터를 인코딩하여 데이터에 대한 비인가 접근을 막는다. HTTPS 프로토콜로 데이터 암호화 및 엔드포인트 인증을 할 수 있다.

 

💡REST API 사례

대표적인 REST API인 Twitter REST API로 tweets, users, direct messages 등의 데이터를 접근할 수 있다. 이로써, 개발자들은 Twitter의 대규모 사용자 정보를 활용할 수 있다. 응답과 요청은 json 형식을 따른다.

 

💡좋은 REST API란

좋은 REST API는 아래의 조건을 충족해야 한다.

1. 직관적인 URL, 리소스, 메소드의 네이밍 컨벤션

2. HTTP 상태 코드를 올바르게 사용한다.

3. 캐싱 기법 활용 - 캐싱을 통해 서버 부하를 줄이고, 응답 시간을 줄일 수 있다. ETag나 Last-Modified와 같은 HTTP 헤더들로 가능하다.

4. 요청, 응답 등의 명확한 설명과 예시

5. Versioning을 통한 API 유지보수

6. 암호화 및 보안 프로토콜을 활용한 인증 및 인가

7. 에러 핸들링으로, 서버 고장을 막고 에러 원인을 사용자에게 설명하고 로깅 및 분석

 

💡결론

정리하면, REST API의 핵심 요점은 아래와 같다.

• 웹 서비스들이 어떻게 통신할지를 정의한 설계 규칙의 모음
• 무상태성, 단일화된 인터페이스, URI를 통한 리소스 식별
• HTTP 메소드로 CRUD 연산 수행
• 엔드포인트, 리소스, 메소드, 응답 및 요청 형식과 상태 코드를 포함한 HTTP 메세지
• 인증, 인가, 암호화 및 API Key를 통한 REST API 보안 설정