API 종류(1) - REST API

API 종류 - REST API

REST API 공부에 앞서 REST에 대해 알아보려고 한다.

1. REST 란?

• HTTP URI을 통해 자원(Resource)을 명시하고 Method(POST, GET, PUT, DELETE, PATCH 등)을 통하여 해당 URI에 대한 CRUD를 적용하는 것을 의미한다.
  
  

2. REST 특징

2-1. Server Client 구조

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.

2-2. Stateless(무상태성)

• HTTP 프로토콜은 Stateless Protocol 이므로 REST 역시 무상태성을 가지며 Client의 context를 Server에 저장하지 않는다.
• 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 된다.
• Server는 각각의 요청을 완전히 별개의 것으로 인식한 후 처리한다.

2-3. Cacheable(캐시 처리 기능)

• HTTP의 특징인 캐싱 기능을 적용 할 수 있다. 그로인한 응답시간의 단축과 REST Server 트랜잭션이 발생하지 않기 때문에 전체적인 기능을 향상 시킬 수 있다.
  • 트랜잭션 : 하나 이상의 SQL 문장들로 이루어진 논리적인 작업 단위

2-4. Layered Sytem(계층화)

• Client는 REST API Server만 호출하고, REST Server는 다중 계층으로 구성 될 수 있다.
• PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

2-5. Uniform Interface(인터페이스 일관성)

• URL로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.

REST API란?

• REST API(RESTful API 또는 RESTful 웹 API)란 REST를 기반으로 서비스 API를 구현한 것으로서 Open API, 마이크로 서비스 등을 제공하는 곳에서도 REST API를 제공한다.

REST API 특징

• 사내 시스템들도 REST 기반으로 시스템을 분산하여 확장성과 재사용성을 높여 유지보수 및 운용을 할 수 있다.
• HTTP 표준을 기반으로 구현하므로 HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현 할 수 있다.

REST API 설계 기본 규칙

1. URI는 정보의 자원을 표현해야 한다.

• resource는 동사보다 명사를, 대문자 보다는 소문자를 사용한다.
• resource의 도큐먼트 이름으로 단수 명사를 사용해야 한다.
• resource의 컬렉션과 스토어 이름으로는 복수 명사를 사용해야 한다.
  ex) GET /Member/1 -> GET /members/1

2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELTE 등)로 표현한다.

• URI에 HTTP Method가 들어가면 안된다.
  ex) GET /members/delete/1 -> DELETE /members/1
• URI에 행위에 대한 동사 표현이 들어가면 안된다.
  ex) GET /members/show/1 -> GET /members/1
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.
  ex) student를 생성하는 route:POST/students
  ex) id=12인 student를 삭제하는 route:DELETE/student/12

REST API 설계 규칙

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

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

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

• REST API는 분명한 URI를 만들어 통신을 해야하기 때문에 혼동을 주지 않도록 URI 경로의 마직막에 슬래시를 사용하지 않는다.
  ex) http://restapi.example.com/houses/apartments/ (X)

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

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

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

• URI 문법 형식은 URI 스키마와 호스트를 제외하고 대소문자를 구분하도록 규정하기 때문이다.

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

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

• /리소스명/리소스ID/관계가 있는 리소스명 으로 표기한다.
  ex) GET: /users/{userid}/devices

RESTful 이란?

• REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어로서 REST API를 제공하는 웹 서비스를 RESTful이라고 할 수 있다.

RESTful 목적

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

RESTful 하지 못한 경우

• CRUD 기능을 모두 POST로만 처리하는 API
• route에 resource, id 외의 모든 정보가 들어가는 경우

(참고) 응답상태 코드

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

다음은 GraphQL API에 대하여 공부 할 예정이다.

---

참고자료(출처)

https://www.ibm.com/kr-ko/topics/rest-apis
https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
https://www.redhat.com/ko/topics/api/what-is-a-rest-api