💻 Dev_Log

Page List

REST API

REST API

Date

2024/08/29

REST

REpresentational State Transfer

웹 서비스 구축 및 관리에 널리 사용되는 디자인 스타일로, 주요 목표는 서로 다른 소프트웨어 애플리케이션 간의 상호 운용성을 활성화하여 통합 및 작업을 훨씬 쉽게 만드는 것이다.

REST API의 작동 방식

REST API는 HTTP 프로토콜을 활용하여 클라이언트와 서버 간에 데이터를 교환한다.

각 HTTP 요청은 메서드, URI(Uniform Resource Identifier), 헤더 및 메시지 본문으로 구성된다. 서버는 메서드와 URI를 기반으로 요청을 처리하고 상태 코드, 헤더 및 메시지 본문이 포함된 HTTP 응답을 반환한다.

REST는 GET, POST, PUT, DELETE 메서드로 각각 CRUD를 처리한다.

REST 기본 원칙

클라이언트-서버 구조: 클라이언트와 서버 간의 책임을 분리하여 클라이언트는 사용자 인터페이스 및 사용자 경험에 집중하고, 서버는 데이터 처리 및 저장을 관리한다. 이는 애플리케이션을 더 모듈화하고 유지보수 가능하게 만든다.

무상태성 (Stateless): 각 요청은 자체적으로 완전해야 하며, 서버는 클라이언트의 상태를 저장하지 않는다. 모든 정보는 요청에 포함되어야 하며, 클라이언트는 각 요청에서 필요한 상태를 제공해야 한다. 이를 통해 서버 확장성이 향상된다.

캐시 처리 가능성: 응답 데이터는 캐시될 수 있어야 한다. 클라이언트는 캐시 가능한 응답을 저장하고, 같은 요청에 대해 서버에 다시 요청하지 않도록 할 수 있다. 이를 통해 네트워크 효율성과 성능이 개선된다.

계층화 시스템 (Layered System): 클라이언트와 서버 간의 중개자(예: 프록시, 게이트웨이)를 두어 시스템의 보안성 및 확장성을 향상시킬 수 있다. 클라이언트는 중간 레이어의 존재를 인식하지 못한다.

인터페이스 일관성 (Uniform Interface): REST는 일관된 인터페이스를 제공한다. 이를 통해 서로 다른 클라이언트와 서버가 상호 작용할 수 있다. 

일관된 인터페이스의 주요 구성 요소:

•

리소스 식별: 모든 리소스는 고유한 URI를 통해 식별된다.

•

리소스 표현: 리소스는 XML, JSON 등의 형식으로 표현된다.

•

표현을 통한 상태 전달: 클라이언트는 요청을 통해 서버의 상태를 변경하거나, 서버로부터 리소스 상태를 전달받는다.

REST API 활용 시 과제

•

버전 관리: API가 발전함에 따라 이전 버전을 사용하는 클라이언트에 대한 이전 버전과의 호환성을 보장하는 것이 어려울 수 있다.

•

인증 및 권한 부여: REST API를 보호하려면 적절한 인증 및 권한 부여 메커니즘을 구현해야 한다. 기본 인증, OAuth 또는 JWT(JSON 웹 토큰)와 같은 여러 표준 방법을 사용할 수 있지만 API 보안을 위해서는 올바른 접근 방식을 선택하고 적절한 구현을 보장하는 것이 중요하다.

•

비율 제한 및 할당량: 비율 제한 및 할당량을 적용하면 API의 과도한 사용이나 남용을 방지하고 모든 클라이언트에 대한 공정한 액세스를 보장할 수 있다. 이러한 제어를 구현하는 것은 어려울 수 있으므로 개발자는 적법한 사용 사례를 수용할 수 있는 유연성과 엄격함의 균형을 유지하도록 주의를 기울여야 한다.

•

호환성: 기술, 플랫폼 및 요구 사항이 서로 다른 다양한 클라이언트가 사용할 수 있는 REST API를 설계하는 것은 어려울 수 있다. 널리 인정되는 표준과 모범 사례에 주의를 기울이면 호환성과 유지 관리 가능성을 보장하는 데 도움이 된다.

•

오류 처리 및 문서화: 성공적인 REST API를 위해서는 명확한 오류 메시지와 포괄적인 문서를 제공하는 것이 필수적이다. 적절한 오류 처리를 통해 클라이언트 혼란을 방지하고 문제 디버깅 및 해결에 필요한 시간을 줄일 수 있다.

URI, URL, URN

URL 구성 이해하기

•

프로토콜 : https

•

호스트명 : www.google.com

•

포트번호 : 443

•

패스 : /search

•

쿼리 파라미터 : q=hello&hl=ko

Scheme

•

주로 프로토콜(어떤 방식으로 자원에 접근할 것인가 하는 약속 규칙)사용

•

예) http, https, ftp 등등

•

http는 80 포트, https는 443 포트를 주로 사용, 포트는 생략 가능

host

•

호스트명(www.google.com)

•

도메인명 또는 IP 주소를 직접 사용 가능

port

•

접속 포트

•

일반적으로 생략 가능

•

생략 시 http는 80, https는 443 포트 번호로 설정된다.

•

톰캣은 8080 포트를 사용

path

•

리소스 경로(path)

•

계층적 구조로 구성됨

◦

/home/file1.jpg

◦

/members

◦

/members/100

◦

/items/iphone12

query

•

query parameter, query string 등으로 불림, 웹서버에 제공하는 파라미터, 문자 형태

•

key=value 형태

•

?로 시작되며, &로 여러개 추가 가능

•

ex) ?keyA=valueA&keyB=valueB

fragment

•

html 내부 북마크 등에 사용

•

웹문서 해시태크라고도 불림

•

서버에 전송하는 정보 아님

Reference

REST API 작동 방식 | AppMaster

REST API가 기업의 소프트웨어 애플리케이션을 효과적으로 통합하는 데 어떻게 도움이 되는지 알아보세요.

https://appmaster.io/ko/blog/nameoji-api-jagdong-bangsig

🌐 URL 구성 요소 & 요청 흐름 정리

URL 구성 이해하기 프로토콜 : https 호스트명 : www.google.com 포트번호 : 443 패스 : /search 쿼리 파라미터 : q=hello&hl=ko scheme 주로 프로토콜(어떤 방식으로 자원에 접근할 것인가 하는 약속 규칙) 사용 예) http, https, ftp 등등 http는 80 포트, https는 443 포트를 주로 사용, 포트는 생략 가능 userinfo URL에 사용자 정보를 포함해서 인증 요즘은 거의 사용하지 않음 host 호스트명(www.google.com) 도메인명 또는 IP 주소를 직접 사용 가능 port 접속 포트 일반적으로 생략 가능 생략 시 http는 80, https는 443 포트 번호로 설정된다. 톰캣은 8080 포트를 사용 path 리소스 경로(pa..

https://inpa.tistory.com/entry/WEB-🌐-URL-구성-요소-요청-흐름-정리?category=889117