[RestAPI] Rest, RestAPI 설명 및 설계 규칙

RestAPI를 설명하기 이전에 Rest가 뭔지 부터 알아보자.

 

Rest 란?

 

 

 

 

Rest는 Representational State Transfer의 약자로써 자원을 이름으로 구분해 해당 자원의 상태를 주고 받는것을 뜻한다.

 

즉 URI를 통해 자원을 명시하고 HTTP Method를 통해 해당 자원에 대한 CRUD Operation을 적용하는것이다

 

여기서 말하는 CRUD란 아래의 약자이다.

 

C - Create(생성)

R - Read(조회)

U - Update(수정)

D - Delete(삭제)

 

HTTP Method에서의 CRUD는 보통 아래와 같다.

 

Create - Post

Read - Get

Update - Put

Delete - Delete 

 

HTTP 메소드에 대한 자세한 설명은 아래 링크에 나와 있으니 참조하면 될것 같다.

 

https://girawhale.tistory.com/66

HTTP 메소드의 종류와 특징, 속성

 

 

Rest의 특징

 

1. 특정 플랫폼에 종속되어 있지 않음 

 

특정 언어나 운영체제와 관계없이 모든 플랫폼에서 사용이 가능하다.

 

2. Stateless 

 

REST는 무상태성 성격을 가진다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.

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

 

3. Cacheable (캐시 가능)

 

REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다.

따라서 HTTP가 가진 캐싱 기능이 적용할 수 있다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

 

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

 

REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다는 것이다.

 

5. Client - Server 구조

 

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

각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로 간 의존성이

줄어들게 된다.

 

6. 계층형 구조

 

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

REST의 장단점

장점

1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
2. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
3. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
4. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
5. REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
6. 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
7. 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

1. 표준이 자체가 존재하지 않아 정의가 필요하다.
2. 사용할 수 있는 메소드가 4가지밖에 없다.
3. HTTP Method 형태가 제한적이다.
4. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
5. 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)

 

 

그렇담 RestAPI란 무엇일까??

 

RestAPI란?

 

RestAPI는 위에서 설명란 Rest 기반으로 API를 구축한것이다.

 

1.  소문자를 사용한다

 

대문자는 가끔 문제가 될수 있기 때문에 URI를 작성할때는 소문자를 선호한다.

 

Bad 

http://restapi.example.com/practiceApi  

 

Good

http://restapi.example.com/practice-api 

 

 

2. 언더바 대신 하이픈을 사용한다.

 

가독성을 위해서 path를 표현하는 단어는 하이픈으로 구분하는것이 좋고 하이픈은 간혹 문자가 부분적으로 가려지거나 숨겨질수 있어서 지양해야한다.

 

Bad

http://restapi.example.com/practice_api  

 

Good

http://restapi.example.com/practice-api 

 

 

3. URI의 마지막에는 / 를 포함하지 않는다.

 

URI 내의 모든 문자는 리소스의 고유 ID를 뜻한다. 따라서 / 가 있고 없고의 차이에 따라 서로 다른 리소스를 받을수 있다.

 

Bad

http://restapi.example.com/practice-api/  

 

Good

http://restapi.example.com/practice-api 

 

 

4. 계층관계를 나타낼때는 슬래시 구분자를 사용해야한다.

 

자원간의 계층적관계를 나타낼때는 / 구분자를 사용해서 계층관계를 나타내야 한다.

 

Good 

http://restapi.example.com/people/name/이욱재

 

 

5. 행위를 포함하지 않는다.

 

행위는 URL 대신 HTTP 메소드를 사용하여서 전달한다.

 

Bad

http://restapi.example.com/getpractice  

 

Good

http://restapi.example.com/practice 

 

 

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

 

파일 확장자는 URI에 포함하지 말아야한다. 대신에 Content-Type 이라는 헤더를 통해 전달되는대로 미디어 타입을 사용하여 body의 콘텐츠를 처리하는 방법을 결정한다.

 

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

Accept header를 사용하도록 한다.

 

Bad
http://restapi.example.com/practice/project/1/prac.json

Good
http://restapi.example.com/practice/project/1/prac

 

 

7. 전달하고자 하는 자원의 명사를 사용하되, 컨트롤 자원을 의미하는 경우 예외적으로 동사를 허용한다.

 

BAD
http://restapi.example.com/course/writing

GOOD
http://restapi.example.com/course/write

 

 

 

8. 단일항목이 아닌 컬렉션일때는 리소스를 복수명사를 사용해라.

 

Good

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