📝 Restful한 API에 관한 조사
이전에 경험했던 면접에서 Restful한 API가 무엇이며, 어느정도까지 구현했냐는 질문에 어버버거린 기억이 있다. 그래서 이번기회를 통해 진짜로 Restful한 API가 무엇인지 조사하고 정리해보려고 한다.
API의 기본의미부터 Rest에 대한 개념, Rest 성숙도 모델에 관한 내용 순으로 정리해보려고 한다.
🚩 API ( Application Programming Interface )
Application Programming Interface(애플리케이션 프로그램 인터페이스)의 약자로, 소프트웨어 응용 프로그램에서 다른 소프트웨어 구성 요소 또는 서비스와 상호 작용하기 위한 인터페이스를 제공하는 프로그래밍 기술이다.
한마디로 정의하면 내 프로그램을 다른 프로그램이 사용하기 쉽게 문을 만들어 놓은 것이다.
여기서 내 프로그램은 Server를 의미하고 다른 프로그램은 Client 의미한다.
🚩 Rest ( Representational State Transfer )
REST(Representational State Transfer)의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.
기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일이며, 네트워크 상에서 Client 와 Server 사이의 통신 방식 중 하나이다.
📝 Rest 의 자원?
- 프로그램이 컨트롤하고 있는 자원을 의미한다.
- Ex) Database 안에 있는 Data, Image, File ...
📝 Rest 의 자원의 상태를 주고 받는다?
- 말 그대로 Client가 요청한 시점에 내 프로그램이 컨트롤 하고 있는 자원을 보내주는 것을 뜻한다.
- 형식에는 JSON, XML이 있으나, 대부분의 개발자들이 가벼운 JSON을 사용하고 있다.
📝 Rest의 활용
- HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시한다.
- HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 이용하여 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다.
🔨 CRUD Operation
- Create: 생성(POST)
- Read: 조회(GET)
- Update: 수정(PUT)
- Delete: 삭제(DELETE)
- HEAD: header 정보 조회(HEAD)
📝 Rest의 장단점
장점
- HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
- HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
- 서버와 클라이언트 역할을 명확하게 분리된다.
단점
- 표준이 존재하지 않는다.
- 사용할 수 있는 메소드가 4가지(HTTP Method) 뿐이다.
- 구형 브라우저에서 아직 제대로 지원해주지 못하는 부분이 존재한다. ( PUT, DELETE를 사용하지 못하는 점 )
🚩 Rest 성숙도 모델 4단계
리차드슨의 Rest 성숙도 모델 총 4단계(0~3단계)로 나누어진다. 그러나 2단계까지만 적용해도 좋은 API 디자인이라고 말하며, 2단계 부터 HTTP API 라고도 부른다.
📝 리차드슨의 Rest 성숙도 모델
📝 Rest 성숙도 모델 - 0단계
- HTTP 프로토콜을 사용하기만 해도 된다.
→ REST API의 출발 (기본단계)
📝 Rest 성숙도 모델 - 1단계
- 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 하는데, 이때 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.
→ 성공시 성공사유를 보내주고, 실패시 실패사유를 보내준다.
📝 Rest 성숙도 모델 - 2단계
- HTTP 메소드를 정확하게 사용하는것에 중점을 둔다.
→ 요청과 응답에서의 HTTP 메소드와 Response Code의 사용을 정확하게 한다.
📝 Rest 성숙도 모델 - 3단계
- HATEOAS, 하이퍼미디어 컨트롤(Hypertext As The Engine Of Application State)을 적용한다.
즉, 응답에는 리소스의 URI를 포함한 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트이다.
→ Ex) 데이터를 변경했을때의 응답 -> 변경여부 조회 링크, 변경 취소 링크를 응답으로 보내준다.
🚩 Rest API
위에 두 개념을 이해했다면 이 개념은 아주 간단하다. 두 개념을 융합한것 Rest API이다.
📝 Rest API의 설계 규칙
-
URI는 자원의 정보를 표시해야 한다.
- resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다. - resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다. - resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다. - resource의 스토어 이름으로는 복수 명사를 사용해야 한다. -
URI에 HTTML Method가 들어가면 안된다.
-
슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
-
URI 마지막 문자로 슬래시를 포함하지 않는다.
-
URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르며 URI도 달라져야 한다.
-
하이픈(-) 은 URI 가독성을 높이는데 사용한다.
-
밑줄(_)은 사용하지 않는다.
-
URI 경로에는 소문자가 적합하다.
why? ) RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다. -
파일 확장자는 URI에 포함하지 않는다.
🚩 Restful API
RESTful은 일반적으로 REST라는 아키텍쳐를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있다.
따라서 Restful API라는 것은 rest에 개념을 잘 지켜가며 API를 만들면 RestFul한 API라고 한다.
📌 마무리
면접때 제대로 대답하지 못해서 부끄러웠던 Rest에 대한 개념을 정리했다. 대부분 아는내용이었으나 성숙도 모델 4단계 부분이 잘 숙지되지 않아서 대답을 못했던거 같다. 제대로 정리하였으니 재취업이 이루어진다면 개발업무에도 적용하며 나의 성장에 도움이 될것 같다.
