REST, URI, HTTP 요약 정리

REST, URI, HTTP 요약 정리

반응형

REST (REpresentational State Transfer)

무상태(Stateless) : 요청에 대해서 클라이언트의 상태를 서버에 저장하지 않는다.

캐시 처리 가능(Cacheable) : 클라이언트는 서버의 응답을 Cache 할 수 있어야 한다. 클라이언트가 Cache를 통해서 응답을 재사용할 수 있어야 하며, 이를 통해서 서버의 부하를 낮춘다.

계층화(Layered System) : 서버와 클라이언트 사이에 방화벽, 게이트웨이, 프록시 등 다양한 계층 형태로 구성이 가능해야 하며, 이를 확장할 수 있어야 한다.

인터페이스 일관성 : 인터페이스의 일관성을 지키고, 아키텍쳐를 단순화시켜 작은 단위로 분리하여, 클라이언트, 서버가 독립적으로 개선될 수 있어야 한다.

Code On Demand (Optional) : 자바 애플릿, 자바스크립트, 플래시 등 특정한 기능을 서버로부터 클라이언트가 전달받아 코드를 실행할 수 있어야 한다.

클라이언트/서버 구조 : 클라이언트와 서버가 서로 독립적으로 분리되어 있어야 한다.

인터페이스 일관성이 잘 지켜졌는지에 따라 REST를 잘 사용했는지 판단을 할 수 있다.

1. 자원의 식별

웹 기반의 REST에서는 리소스 접근은 할 때 URI를 사용함

https://www.daun.net/user/100

Resource : user, 식별자 : 100

2. 메시지를 통한 리소스 조작

웹에서 데이터를 전달할 때 가장 많이 사용하는 방식은 HTML, XML, JSON, TEXT 등이 있다. 이 중에서 어떠한 타입의 데이터인지 알려주기 위해 HTTP Header 부분에 content-type을 통해 데이터의 타입을 지정해줄 수 있다. 또한 리소스 조작을 위해서 데이터 전체를 전달하지 않고 이를 메시지로 전달한다.

예시) 서버의 user라는 정보의 전화번호를 number라고 결정했다. 하지만, 나중에 서버의 리소스 변경으로 phone-number로 바뀌게 되면 클라이언트는 데이터 처리를 하지 못하고 에러가 난다. 이러한 오류를 방지하기 위해 메시지 형태로 데이터를 주고 받아야하며 Client-Server가 독립적으로 확장 가능하도록 한다.

3. 자기 서술적 메시지

요청하는 데이터가 어떻게 처리되어져야 하는지 충분한 데이터를 포함할 수 있어야 한다.

GET : https://cieldelaube.com/user/100 (사용자의 정보 요청)

POST : https://cieldelaube.com/user (사용자 정보 생성)

PUT : https://cieldelaube.com (사용자 정보 생성 및 수정)

DELETE : https://cieldelaube.com/user/100 (사용자 정보 삭제)

4. 애플리케이션 상태에 대한 엔진으로써 하이퍼미디어

REST API를 개발할 때 단순히 클라이언트 요청에 대한 데이터만 응답해주는 것이 아닌 관련된 리소스에 대한 Link 정보까지 같이 포함되어져야 한다. 이러한 조건들을 잘 갖춘 경우 RESTful 하다고 표현하고 이를 REST API라고 부른다.

URI(Uniform Resource Identifier)

인터넷에서 특정 자원을 나타내는 주소값. 해당 값은 유일하다. (응답은 달라질 수 있다.)

요청 : https://www.cieldelaube.com/resource/sample/1

응답 : cieldelaube.pdf, cieldelaube.docx

※ URI 설계 원칙 (RFC-3986)

'/'는 계층 관계를 나타내는 데 사용한다.

URI 마지막 문자로 '/'는 포함하지 않는다.

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

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

URI 경로에는 소문자가 적합하다.

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

프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.

구현에 의존적인 경로를 사용하지 않는다. (servlet)

세션 ID를 포함하지 않는다. (.../web-master ?session-id=abcdef )

) 프로그래밍 언어의 Method명을 사용하지 않는다. (.../web-master ?action=intro )

) 명사에 단수형 보다는 복수형을 사용해야 한다. 컬렉션에 대한 표현은 복수로 사용 (classes, curriculums)

컨트롤러 이름으로는 동사나 동사구를 사용한다. (.../web-master/re-order)

경로 부분 중 변하는 부분은 유일한 값으로 대체한다. ({lesson-id}/users/{user-id} -> 2/users/100)

CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.

URI 쿼리 부분으로 컬렉션 결과에 대해서 필터링 할 수 있다. (.../web-master ?chapter=2 )

) URI Query는 컬렉션의 결과를 페이지로 구분하여 나타내는데 사용한다. (.../web-master ?chapter=2&page;=0&size;=10&sort;=asc)

API에 있어서도 서브 도메인은 일관성 있게 사용해야 한다. (https:// api. cieldelaube.com, https:// api- cieldelaube.com)

cieldelaube.com, https:// cieldelaube.com) 클라이언트 개발자 포탈 서브 도메인은 일관성 있게 만든다. (https://dev-cieldelaube.com, https://developer-cieldeluabe.com)

* URL(Uniform Resource Locator)

- 인터넷 상에서의 자원, 특정 파일이 어디에 위치하는지 식별하는 주소

- 요청 : https://www.cieldelaube.com/cieldelaube.pdf

- URL은 URI의 하위 개념

HTTP(Hyper Text Transfer Protocol)

RFC 2616에서 규정된 Web에서 데이터를 주고받는 프로토콜

HTML, XML, JSON, Image, Voice, Video, Javascript, PDF 등을 모두 전송할 수 있다.

TCP를 기반으로 한 REST의 특징을 모두 구현하고 있는 Web 기반의 프로토콜

의미 CRUD 멱등성 안정성 Path

Variable Query Parameter Databody GET 리소스 취득 R O O O O X POST 리소스 생성, 추가 C X X O △ O PUT 리소스 갱신, 생성 C / U O X O △ O DELETE 리소스 삭제 D O X O O X HEAD 헤더 데이터 취득 - O O - - - OPTIONS 지원하는 메소드 취득 - O - - - - TRACE 요청메시지 반환 - O - - - - CONNECT 프록시 동작의 터널 접속으로 변경 - X - - - -

※ HTTP Status Code

의미 내용 1XX 처리중 처리가 계속되고 있는 상태. 클라이언트는 요청을 계속하거나 서버의 지시에 따라서 재요청 2XX 성공 요청의 성공 3XX 리다이렉트 다른 리소스로 리다이렉트. 해당 코드를 받았을 때는 Response의 새로운 주소로 다시 요청 4XX 클라이언트 에러 클라이언트의 요청에 에러가 있는 상태. 재전송 하여도 에러가 해결되지 않는다. 5XX 서버 에러 서버 처리중 에러가 발생한 상태. 재전송시 에러가 해결되었을 수도 있다.

200 : 성공

201 : 성공. 리소스를 생성 성공

301 : 리다이렉트. 리소스가 다른 장소로 변경됨을 알림

303 : 리다이렉트. Client에서 자동으로 새로운 리소스로 요청 처리

400 : 요청 오류. 파라미터 에러

401 : 권한 없음 (인증 실패)

404 : 리소스 없음 (페이지를 찾을 수 없음)

500 : 서버 내부 에러 (서버 동작 처리 에러)

503 : 서비스 정지 (점검 등)

반응형

from http://yunseodozpwf.tistory.com/27 by ccl(A) rewrite - 2021-11-08 20:27:49