REST API

API(Application Programming Interface, 응용프로그램 프로그래밍 인터페이스)

프로그래밍에서 프로그램을 작성하기 위한 일련의 부 프로그램

프로토콜 등을 정의하여 상호 작용을 하기 위한 인터페이스 사양이다.

 

API는 소프트웨어 컴포넌트(Function, Method, Operation)의 기능, 입력, 출력, 그리고 이에 사용되는 자료형으로 표현된다.

API 자체는 어디까지나 사양(Specification)만을 정의하기 때문에 구현물(Implementation)과 독립적이다.

 

API가 실제 기능 구현체인 라이브러리와 함께 제공되는 경우도 있으며, 이를 Software Development Kit(SDK)라고 한다.

SDK는 보통 API, 라이브러리와 함께 프로그램을 개발하는데 필요한 여러 보조 프로그램이 같이 배포된다.

 

API는 소스 코드 수준에서 정의되는 인터페이스다. 

이와는 달리 기계어 이진 바이너리 수준에서 정의되는 이러한 인터페이스를 Application Binary Interface(ABI)라고 한다. 

API 자체는 구현물과 독립적인 관계에 있다.

---

REST(Representational state transfer)

네트워크 구조의 한 형식으로 서버의 자원을 정의하고 자원에 대한 주소를 지정하는 방법

일반적으로 REST라고 하면 좁은 의미로 HTTP를 통해 CRUD를 실행하는 것을 뜻한다.

CRUD => Create : 생성(POST) / Read : 조회(GET) / Update : 수정(PUT) / Delete : 삭제(DELETE)

 

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, 

HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고

HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처를 의미한다.

 - 자원(resource)의 표현(representation)
자원 : 해당 소프트웨어가 관리하는 모든 것(문서, 그림, 데이터, 해당 소프트웨어 자체 등)

자원의 표현 : 그 자원을 표현하기 위한 이름(DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다.)

 - 상태(정보) 전달

데이터가 요청되는 시점에서 자원의 상태(정보)를 전달한다. JSON 혹은 XML를 통해 데이터를 주고받는 것이 일반적이다.

 

REST 특징

① 클라이언트-서버 아키텍처

    REST 아키텍처가 클라이언트, 서버, 리소스로 구성되며 HTTP를 통해 요청을 처리한다. 

    자원(resource)이 있는 쪽이 서버가 되며, 요청을 하는 쪽이 해당 서버에 대한 클라이언트가 된다. 

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

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

② Stateless 

    요청이 오갈 때 클라이언트 콘텐츠가 서버에 저장되지 않으며 대신 세션 상태에 대한 정보는 클라이언트에 보관된다. 

    세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다.

    서버는 각각의 요청을 완전히 별개의 것으로 인식하고 처리해야 하며, 이전 요청이 다음 요청의 처리에 연관이 되어서는 안 된다.

    따라서 서버의 처리 방식에 일관성을 부여하고 서버의 부담이 줄어든다. 

③ Cacheable(캐시 처리 가능)

    캐싱으로 일부 클라이언트-서버 상호 작용의 필요성을 없앨 수 있다. 

    대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다. 

    HTTP 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 인프라를 그대로 활용이 가능하고 HTTP가 가진 캐싱 기능이

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

④ 계층화된 시스템

    REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY,

    게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있게 한다.

⑤ Code on demand(optional)

    서버가 실행 가능한 코드(스크립트)를 전송하여 클라이언트의 기능을 확대할 수 있다. 

⑥ Uniform Interface(통합된 인터페이스)

    URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일

 - 요청에서 리소스 식별 : 리소스가 요청에서 식별되며 클라이언트로 반환된 표현으로부터 분리된다. 
 - 표현을 통한 리소스 조작 : 클라이언트가 리소스를 나타내는 파일을 수신한다. 

    이 표현에는 조작 또는 삭제를 허용할 수 있도록 충분한 양의 정보가 포함되어야 한다. 
 - Self-descriptiveness(자체 표현 구조) : 클라이언트에 반환되는 각 메시지에 클라이언트가 정보를 어떻게 처리해야 할지 

    설명하는 정보가 충분히 포함되어야 한다. REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다.
 - 애플리케이션 상태 엔진으로써의 하이퍼미디어 : 리소스를 할당한 후 REST 클라이언트가 하이퍼링크를 통해 현재 사용 가능한

    기타 모든 작업을 찾을 수 있어야 한다.

 

REST 구성 

HTTP 프로토콜을 이용하기 때문에 URL(route)를 통해 자원을 특정 짓고 HTTP Verbs를 통해 할 일(CRUD)을 지정한다.

또한 JSON 혹은 XML를 통해 데이터를 주고받는다. 

 

① 자원(RESOURCE) - URI 

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

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

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

---

RESTful API

REST 기반으로 서비스 API를 구현한 것

최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 

마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처)등

을 제공하는 업체 대부분은 REST API를 제공한다.

RESTful API 설계 규칙

① URI는 정보의 자원(Resource)을 표현해야 한다.
    resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
    resource의 Document 이름으로는 단수 명사를 사용해야 한다.
    resource의 Collection 이름으로는 복수 명사를 사용해야 한다.
    resource의 store 이름으로는 복수 명사를 사용해야 한다.
    ex) GET /Member/1 -> GET /members/1

 

Document : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념

Collection : 서버에서 관리하는 디렉터리라는 리소스

store : 클라이언트에서 관리하는 리소스 저장소

Collection은 Document 들의 집합, 객체들의 집합  /  Document는 하나의 문서 or 객체 

ex) http:// restapi.example.com/sports/soccer 

       => sports 컬렉션 / soccer 도큐먼트

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

       => sports 컬렉션 / soccer 도큐먼트 / players 컬렉션 / 13 도큐먼트 (컬렉션은 복수로 사용하고 있다)

 

② 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)으로 표현해야 한다.

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

    회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST Method를 사용하여 표현한다.
    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

 

URI 설계 규칙

① 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
    ex) http://restapi.example.com/houses/apartments
② URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
    URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고,

    역으로 리소스가 다르면 URI도 달라져야 한다.

    REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.

    http://restapi.example.com/houses/apartments/ (X)

    http://restapi.example.com/houses/apartments (0)

③ 하이픈(-)은 URI 가독성을 높이는 데 사용
    불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
④ 밑줄(_)은 URI에 사용하지 않는다.
    밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
⑤ URI 경로에는 소문자가 적합하다.
    대소문자에 따라 다른 리소스로 인식한다.
⑥ 파일 확장자는 URI에 포함하지 않는다.

    http://restapi.example.com/members/soccer/345/photo.jpg (X)

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

    Accept header를 사용한다.

    GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

⑦ 리소스 연관관계

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

 

HTTP Methods(HTTP-Verbs)

HTTP 신호의 타입들을 분류해 놓은 것 그중에 자주 쓰이는 GET, POST, PUT, PATCH, DELETE

① GET

    서버 자원을 가져오고자 할 때 사용한다. 요청의 본문(body)에 데이터를 넣지 않는다.

    데이터를 서버로 보내야 한다면 쿼리 스트링을 사용한다.

    서버에게 resource를 보내달라고 요청한다. 서버(혹은 DB)의 resource는 클라이언트로 전달만 될 뿐 변경되지 않는다.

② POST 

    서버에 자원을 새로 등록하고자 할 때 사용한다. 요청의 본문에 새로 등록할 데이터를 넣어 보낸다.

③ PUT 

    서버의 자원을 요청에 들어 있는 자원으로 치환하고자 할 때 사용한다. 요청의 본문에 치환할 데이터를 넣어 보낸다.

    서버에게 resource의 업데이트하거나 resource가 없다면 새로운 resource를 생성해 달라고 요청한다.

    PUT은 PATCH와 비교해서 전체 데이터를 교체하는 차이점이 있다. 
    가령 user data의 구조가 user._id, user.firstName, user.lastName, user.age라고 한다면, 

    회원정보 수정 시 PUT은 _id를 찾아 age만 업데이트하더라도 항상 모든 필드값을 가져와서 모든 필드를 항상 새로운 값으로 

    교체한다. 

④ PATCH

    서버 자원의 일부만 수정하고자 할 때 사용한다. 요청의 본문에 일부 수정할 데이터를 넣어 보낸다.   
    PATCH는 PUT과 비교해서 부분 데이터를 업데이트하는 차이점이 있다. 
    가령 user data의 구조가 user._id, user.firstName, user.lastName, user.age라고 한다면, 

    회원정보 수정시 PATCH는 _id를 찾아 age만 업데이트할 때 _id와 age만 받아 와서 해당 부분을 업데이트한다. 

⑤ DELETE 

    서버의 자원을 삭제하고자 할 때 사용한다.

 

RESTful API 설계 예시

HTTP 메서드	주소	역할
GET	/	restFront.html 파일 제공
GET	/about	about.html 파일 제공
GET	/users	사용자 목록 제공
GET	기타	기타 정적 파일 제공
POST	/users	사용자 등록
PUT	/users/사용자 id	해당 id의 사용자 수정
DELETE	/users/사용자 id	해당 id의 사용자 제거

 

HTTP 상태 코드

REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다. 

 

2xx : 성공을 알리는 상태 코드

 - 200(성공) : 클라이언트의 요청을 정상적으로 수행함

 - 201(작성됨) : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

 

3xx : 리다이렉션(다른 페이지로 이동)을 알리는 상태 코드. 어떤 주소를 입력했는데 다른 주소의 페이지로 넘어갈 때 사용된다.

 - 301(영구 이동) : 클라이언트가 요청한 리소스에 대한 URI가 변경되었을 때 사용하는 응답 코드

                               (응답 시 Location header에 변경된 URI를 적어 줘야 한다.)

 - 302(임시 이동)

 

4xx : 요청 오류를 나타낸다. 요청 자체에 오류가 있을 때 표시

 - 401(권한 없음) : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드

                               (로그인하지 않은 유저가 로그인했을 때, 요청 가능한 리소스를 요청했을 때)

 - 403(금지됨) : 유저 인증 상태와 관계없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드

                           (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)

 - 404(찾을 수 없음)

 - 405 : 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

 

5xx : 서버 오류를 나타낸다. 요청은 제대로 왔지만 서버에 오류가 생겼을 때 발생한다.

        이 오류를 클라이언트로 res.writeHead로 직접 보내는 경우는 없고 예기치 못한 에러 발생 시 서버가 알아서 5xx대 코드를 보낸다.

 - 500(내부 서버 오류) : 서버에 문제가 있을 경우 사용하는 응답 코드

 - 502(불량 게이트웨이)

 - 503(서비스를 사용할 수 없음)

 

RESTful하지 못한 예시

1. CRUD기능을 모두 POST로만 처리하는 API

2. Route에 resource, id 외 정보가 들어가는 경우

   (/students/updateName, student 하나의 이름만 변경하는 API의 경우 PUT students/:id/name이 되어야 한다.)

---

참고사이트

https://meetup.toast.com/posts/92

https://www.a-mean-blog.com/ko/blog/%ED%86%A0%EB%A7%89%EA%B8%80/_/REST%EC%99%80-RESTful-API

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html