REST API

mangez_js·2025년 2월 11일

목록 보기

1/1

REST API의 탄생

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

REST 구성

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

HTTP URI

Uniform Resource Identifier

구성 요소

URL(Uniform Resource Locator)
- Scheme : 리소스에 접근하기 위한 프로토콜 기본은 https
- Host : 리소스를 호스팅 하는 서버 이름
- Port : 외부에서 서버의 리소스에 접근하기 위해 사용되는 게이트
UBN(Uniform Resource Name)
- Path : 호스트 내 리소스의 위치
- Query Parameters : 리소스에 전달되는 추가 정보
- Fragment Identifier : 부가적인 식별자

REST의 특징

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

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

2) Stateless(무상태성)

작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다.
세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다.
때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

3) Cacheable(캐시 가능)

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

4) Self-descriptiveness(자체 표현 구조)

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

5) Client-Server 구조

REST 서버는 API 제공
클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분

6) 계층형 구조

REST 서버는 다음 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있다
a. 보안
b. 로드밸런싱 -> 프록시
로드밸런싱 : H/W, 트래픽 부하 조절
프록시 : 경로 조절
로드밸런서가 부하에 따라 서버를 생성할 수도 종료할 수도 있다.

REST API 디자인 가이드

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

자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

REST API 중심 규칙

1) URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)

GET /members/delete/1 "헤더 라인을 표현한 겁니다."

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다.
URI는 자원을 표현하는데 중점을 두어야 합니다. delete와 같은 행위에 대한 표현이 들어가서는 안된다.

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현

위의 잘못된 URI를 HTTP Method를 통해 수정해 보안

DELETE /members/1

으로 수정할 수 있습니다.
회원정보를 가져올 때는 GET,
회원 추가 시의 행위를 표현하고자 할 때는 POST METHOD를 사용하여 표현

회원정보를 가져오는 URI

GET /members/show/1 (x) * show는 행위, 보겠다는 의도는 알겠지만 권장 X
GET /members/1 (o)

회원을 추가할 때

GET /members/insert/2 (x) * GET 메서드는 리소스 생성에 맞지 않습니다.
POST /members/2 (o)

URI 설계 시 주의할 점

1) 슬래시 구분자(/)는 계층 관계를 나타내는데 사용

http://restapi.example.com/houses/apartments
http://restapi.example.com/animals/mammals/whales

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

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다.

REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

http://restapi.example.com/houses/apartments/ (X)
http://restapi.example.com/houses/apartments (O)

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

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

4) 밑줄(_)은 URI에 사용하지 않는다.

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

5) URI 경로에는 소문자가 적합

URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하기 때문이다

6) 파일 확장자는 URI에 포함시키지 않는다.

http://restapi.example.com/members/soccer/345/photo.jpg (X)

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

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

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현 방법을 사용

/리소스명/리소스 ID/관계가 있는 다른 리소스명
ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표한하는 방법이 있다.
예를 들어 사용자가 '좋아하는' 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

자원을 표현하는 Collection과 Document

Document는 단순히 문서로 이해해도 되고, 한 객체라고 이해하셔도 될 것 같습니다.
Collection은 문서들의 집합, 객체들의 집합이라고 생각

컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현
http:// restapi.example.com/sports/soccer
위 URI를 보시면 sports라는 컬렉션과 soccer라는 도큐먼트로 표현되고 있다고 생각하면 된다.

HTTP 응답 상태 코드

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

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

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

참고 문헌

https://inpa.tistory.com/entry/WEB-%F0%9F%8C%90-REST-API-%EC%A0%95%EB%A6%AC
https://thin-cupboard-d95.notion.site/REST-API-15e09d35c17e81888ce1d1d333a17bdf

mangez_js

REST API

REST API

REST API의 탄생

REST 구성

HTTP URI

REST의 특징

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

2) Stateless(무상태성)

3) Cacheable(캐시 가능)

4) Self-descriptiveness(자체 표현 구조)

5) Client-Server 구조

6) 계층형 구조

REST API 디자인 가이드

REST API 중심 규칙

1) URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현

URI 설계 시 주의할 점

1) 슬래시 구분자(/)는 계층 관계를 나타내는데 사용

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

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

4) 밑줄(_)은 URI에 사용하지 않는다.

5) URI 경로에는 소문자가 적합

6) 파일 확장자는 URI에 포함시키지 않는다.

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

자원을 표현하는 Collection과 Document

HTTP 응답 상태 코드

참고 문헌

0개의 댓글