[REST] REST API & RESTful

유동균·2023년 1월 26일

목록 보기

2/2

REST API???

API(Application Programming Interface)???

소프트웨어 프로그램(애플리케이션) 내부에 존재하는 기능 및 규칙의 집합

API는 소프트웨어를 통해 상호작용이 가능하기에, API는 API를 제공하는 애플리케이션과 서드파티 소프트웨어 및 하드웨어 등 사이의 간단한 커뮤니케이션 계약

역할

API는 서버와 데이터베이스에 대한 출입구 역할을 한다.

API는 애플리케이션과 기기가 원활하게 통신할 수 있도록 한다.

API는 모든 접속을 표준화한다.

1. REST API

정의

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

2. REST API의 특징

사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
즉, REST API를 제작하면 델파이 클라이언트 뿐만아니라 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

3. REST API 설계 기본 규칙

리소스 원형

도큐먼트(Document) : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념

컬렉션(Colllection) : 서버에서 관리하는 디렉터리라는 리소스

스토어(Store) : 클라이언트에서 관리하는 리소스 저장소

URI는 정보의 자원을 표현해야 한다.

resource는 동사보다 명사를, 대문자보다 소문자
resource의 도큐먼트 이름은 단수 명사
resource의 컬렉션 이름은 복수 명사
resource의 스토어 이름은 복수 명사
- 스토어의 이름은 복수명사를 사용하고 소문자
  GET /Member/1 -> GET /members/1

자원에 대한 행위는 HTTP Method로 표현한다.

URI에 HTTP Method가 들어가면 안된다.
- delete와 같은 행위에 대한 표현이 들어가서는 안됨
  GET /members/delete/1 -> GET /members/1
URI에 행위에 대한 동사 표현이 들어가면 안됨
- 즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않음
  GET /member/show/1 -> GET /member/1
경로 부분 중 변하는 부분은 유일한 값으로 대체한다
- 즉, id는 하나의 특정 resource를 나타내는 고유값
  student를 생성하는 route: POST /student
  id=12인 student를 삭제하는 route: DELETE /student/12

4. REST API 설계

규칙

슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
http://restapi.example.com/houses/apartments http://restapi.example.com/animals/mammals/whales

URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야함.
REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지않음
http://restapi.example.com/houses/apartments/ (X) http://restapi.example.com/houses/apartments (0)

하이픈(-)은 URI 가독성을 높이는데 사용

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.

밑줄(_)은 URI에 사용하지 않음

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 함.
이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋음.(가독성)

URI 경로에는 소문자

URI 경로에 대문자 사용은 피하도록 해야 함.
대소문자에 따라 다른 리소스로 인식하게 되기 때문.
RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문.

파일 확장자는 URI에 포함하지 않음

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않음.
http://restapi.example.com/members/soccer/345/photo.jpg (X)
Accept header를 사용.
GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

리소스 간의 관계를 표현하는 방법

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용
/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현
GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

자원을 표현하는 Colllection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워짐.
DOCUMENT는 단순히 문서 또는 한 객체.
컬렉션은 문서들의 집합, 객체들의 집합.
컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현됨

http:// restapi.example.com/sports/soccer

위의 URI는 sports라는 컬렉션과 soccer라는 도큐먼트로 표현됨

http:// restapi.example.com/sports/soccer/players/13

위의 URI는 sports, players 컬렉션과 soccer, 13(13번인 선수)를 의미하는 도큐먼트로 표현됨
중요한 점은 컬렉션은 복수로 사용하고 있다는 점
직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있다.

5. HTTP 응답 상태 코드

잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야함.

정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 생각보다 중요하다.

상태 코드 종류

200 : 클라이언트의 요청을 정상적으로 수행함
201 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)
301 : 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 (응답 시 Location header에 변경된 URI를 적어 줘야 합니다.)
400 : 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401 : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드 (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
403 : 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)
405 : 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드
500 : 서버에 문제가 있을 경우 사용하는 응답 코드

6. RESTful

정의

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어
- ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
- 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

목적

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

RESTful 하지 못한 경우

CRUD 기능을 모두 POST로만 처리하는 API
route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

참고 : Heee's Development Blog

유동균

이전 포스트