5. REST / REST API / RESTFUL

 

참고 사이트 : https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

[Network] REST란? REST API란? RESTful이란? - Heee's Development Blog

 

 

Rest api , Rest ful

 

포트폴리오를 준비하면서 기업들의 요구사항을 보면 많은 기업들이

 

rest ful을 사용해본 지원자를 원하는 경우가 많다

 

그렇다면 Rest ful이란 무엇일까??

 

1. Rest란?

 

Rest api를 알기전에 먼저 Rest가 뭔지를 알아야한다

 

(1) Rest란?

 

Representational State Transfer의 약자로, 자원의 이름으로 구분하여 해당 자원의 상태를 주고 받는 모든 것을 의미한다

 

간단하게 이야기하자면 url에 보통은 /board?username=test 형식으로 파라미터를 url에 전달하게 되는데 이런 형태가 아닌

/board/test 형식으로 간단하게 url에 직관적으로 표현할 수 있는 것을 의미한다고 생각해도 무관하다

 

(2) Rest의 구체적인 개념

 

Rest는 Http URI를 통해 자원을 명시하고 HTTP Method(post,get,put,delete)를 통해서 CRUD Operation을 적용한다는 것을 의미한다

 

여기서

 

C : Post - 생성

R : Get - 조회

U : Put - 수정

D : Delete - 삭제

 

의 역활을하게 된다

 

이것 또한 간단하게 이야기하자면 보통 Spring에서 Controller로 Web을 만들 때 Get, Post만을 이용해서 form으로 데이터를 받아와 처리했다면 Get, Post, Put, Delete를 사용해서 다른 개발자가 봤을 때 확실하게 이 메소드가 어떤 역활을 하는 지를 알 수 있게 표기해준다는 것으로 해석해도 무관할 것이다

 

(3) Rest의 장단점

 

- 장점 - 

● HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API를 위한 별도의 인프로 구축이 필요하지 않다

● HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다

● HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다

● Hyepermedia API의 기본을 충실히 지키면서 범용성을 보장한다

● REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
●여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
● 서버와 클라이언트의 역할을 명확하게 분리한다.

- 단점 - 

● 표준이 존재하지 않는다

● 사용 할 수 있는 Method가 4가지로 제한적이다

● 브라우저를 통해 테스트 할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 더 어렵게 느껴질 수 있다

● 구형 브라우저에서 처리가 불가능 할 수도 있다

 

(4) REST 구성 요소

● 자원(Resource): URI

모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

● 행위(Verb): HTTP Method

HTTP 프로토콜의 Method를 사용한다.
HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.

● 표현(Representation of Resource)

Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

2. REST API란?

 

REST 형식을 지키고 있는 아키텍처를 의미한다

 

(1) REST API의 특징

 

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

(2) 설계 규칙

 

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소

URI는 정보의 자원을 표현해야 한다.
resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

Ex) GET /Member/1 -> GET /members/1

자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
URI에 HTTP Method가 들어가면 안된다.
Ex) GET /members/delete/1 -> DELETE /members/1

URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
Ex) GET /members/show/1 -> GET /members/1
Ex) GET /members/insert/2 -> POST /members/2

경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
Ex) student를 생성하는 route: POST /students
Ex) id=12인 student를 삭제하는 route: DELETE /students/12

(3) REST API 설계 규칙

 

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

 

Ex) http://restapi.example.com/houses/apartments

 

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

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

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

불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
밑줄(_ )은 URI에 사용하지 않는다.
밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

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

 

5. URI 경로에 대문자 사용은 피하도록 한다.

RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
파일확장자는 URI에 포함하지 않는다.

6. REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.

Accept header를 사용한다.

Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

 

7. 리소스 간에는 연관 관계가 있는 경우

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

참고 응답상태코드

1xx : 전송 프로토콜 수준의 정보 교환
2xx : 클라어인트 요청이 성공적으로 수행됨
3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx : 클라이언트의 잘못된 요청
5xx : 서버쪽 오류로 인한 상태코드

 

 

3. Rest ful이란?

 

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

 

(1) RESTful의 목적

 

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

 

(2) RESTful 하지 못한 경우

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