REST API

 API(Application Programming Interface)

• API란 클라이언트가 리소스를 요청할 수 있도록 서버측에서 제공된 인터페이스(interface)를 말한다.
• 이러한 API로 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 한다

 REST API 

웹의 리소스를 HTTP URI 형식으로 표현하고 HTTP를 통해 요청과 응답을 정의하는 방식

웹 애플리케이션에서는 HTTP 메소드를 이용해 서버와 통신을 하는데, 어떤 요청을 보내고 받느냐에 따라 메소드의 사용이 달라지며 그에 따라 제대로 통신이 가능하도록 일종의 규약이 존재한다.

• 자원(RESOURCE) - URI
• 행위(Verb) - HTTP METHOD
• 표현(Representations)
  
  

REST API 디자인 가이드

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

URI 경로 마지막은 반드시 문자여야 한다. 슬래시(/) 다음에 의미 있는 값을 추가하지 않으면 혼동이 올 수 있다.

X : http://api.canvas.com/shapes/
O : http://api.canvas.com/shapes

2. 슬래시(/)를 사용하여 계층적 관계를 나타낸다.

슬래시 문자는 리소스 간의 계층적 관계를 나타내기 위해 URI 경로에 사용된다.

ex) http://api.canvas.com/shapes/polygons/quadrilaterals/squares

3. URI 가독성을 높이려면 하이픈(-)을 사용해야 한다.

URI를 사람들이 쉽게 스캔하고 해석할 수 있더로 하이픈(-) 문자를 사용하여 가독성을 높인다. 영어로 공백이나 하이픈을 사용하면 URI에서는 모두 하이픈을 사용해야 한다.

spinal-case 사용한다.
ex) http://api.example.com/rest/api/this-is-uri-design

4. 밑줄(_)은 URI에 사용해서 안된다.

URI에 하이퍼링크가 걸려있을 경우 종종 URI에 밑줄을 쳐서 클릭할 수 있게 시각화한다. 글꼴에 밑줄(_)문자가 밑줄로 인해 부분적으로 가려지거나 완전히 숨겨질 수 있다.

이러한 혼동을 방지하기 위해서 밑줄대신 하이픈(-)을 사용한다.

5. URI는 소문자로 작성하고, 명사를 사용해야 한다.

리소스를 설명할 때 동사가 아닌 구체적인 명사 사용한다.

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

마침표(.) 문자는 일반적으로 이름과 확장자 부분을 구분하는데 사용된다.
REST API는 메세지의 entity body 형식을 나타내기 위해 URI는 파일 확장자를 포함해서는 안 된다.

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

대신 헤더를 사용하여 본문의 컨텐츠를 처리해야 한다.

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

Accept로 원하는 형식을 보내면, 서버가 그에 맞춰 보내준다.

7. 복수형을 사용한다.

ex) http://api.college.com/students/3248234/courses
     http://api.college.com/students/3248234/courses/physics

 

​

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 좋은 REST API를 작성하기 위한 기본 단계이다.

 

REST 성숙도 모델 - 1단계

1단계에서는 개별 리소스와의 통신을 준비해야 한다고 한다. REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현하기 때문에 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바이다.어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에 적절한 엔드포인트를 작성하는 것이 중요하다. 엔드포인트 작성 시에는 동사, HTTP 메소드 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직하다.또한 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

REST 성숙도 모델 - 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점을 둔다. 모든 요청을 CRUD에 상관없이 POST로만 작성한다면 당연히 적합한 메소드 사용이 아니다.조회(READ)를 하는 행위에는 GET 메소드를, 생성(CREATE)하는 행위에는 POST 메소드를 사용하여 요청을 보내는 것이 바람직하다.또 2단계에서는 POST 요청에 대한 응답이 어떻게 반환되는지도 중요하다. 응답이 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 해야한다.이렇게 해야 REST 성숙도 모델의 2단계를 충족한 것이라 볼 수 있다.메소드를 사용할 때의 규칙이 있다.

• GET : 서버의 데이터를 변화시키지 않는 요청에, 사용지정된 리소스 조회
  • => body(payload)X, 멱등성O
• POST : 요청마다 새로운 리소스를 생성
  • => body(payload)O, 멱등성X
• PUT : 지정된 리소스 전체 교체
  • => body(payload)O, 멱등성O
• PATCH : 수정의 용도로 사용 (리소스 부분교체)
  • => body(payload)O, 멱등성X
• DELETE지정된 리소스 삭제
  • => body(payload)X, 멱등성O

멱등성 : 연산을 여러 번 적용하더라도 결과가 달라지지 않는 성질, 연산을 여러 번 반복하여도 한 번만 수행된 것과 같은 성질

REST 성숙도 모델 - 3단계

3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다.이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.쉽게 말해 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트다.만약 클라이언트 개발자들이 응답에 담겨져 있는 링크들을 눈여겨본다면 이러한 링크들은 조금 더 쉽고 효율적으로 리소스와 기능에 접근할 수 있게 하는 트리거가 될 수 있다.

 

Open API

    글자 그대로 누구에게나 열려있는 API입니다. 그러나 "무제한으로 이용할 수 있다"는 의미는 아닙니다. 기관이나

    API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있습니다.

 

API Key

    API key는 서버의 문을 여는 열쇠라고 볼 수 있습니다. API를 이용하기 위해선 대부분 API Key가 필요합니다.

    서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무도, 이유도 없습니다. 그래서

    로그인된 이용자에게만 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를

    같이 전달해야만 원하는 응답을 받을 수 있습니다.