REST API - 나만의 언어로 블로깅 해보기

 

 

 

 

📌 REST API

 

 

📍REST( Representational State Transfer )

API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍쳐

대규모의 고성능 통신을 안정적으로 지원

 

📍API

애플리케이션 프로그래밍 인터페이스

다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 정의

 

📍 REST API

웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식

 

 

REST 구성

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

 

REST 특징

 

1) 균일한 인터페이스 : 서버가 표준 형식으로 정보를 전송

2) 무상태 : 서버가 이전의 모든 요청과 독립적으로 모든 클라이언트 요청을 완료하는 통신 방법

3) 계층화 시스템 : 여러 계층으로 여러 서버에서 실행되도록 RESTful 웹 서비스를 설계

4) 캐시 가능성 : 클라이언트 또는 중개자에 일부 응답을 저장하는 프로세스인 캐싱을 지원

5) 온디맨드 코드 : 서버는 클라이언트 기능을 일시적으로 확장하거나 사용자 지정 가능

 

 

REST API 이점

 

확장성 유연성 독립성

 

 

용어 정리

• 리소스(Resource): 데이터의 일부입니다. (예. user)
• 콜렉션(Collection): 리소스의 집합입니다. (예. users)
• URL(Identifies the location): 리소스 혹은 콜렉션을 식별할 수 있는 경로입니다

 

 

 

🔗REST API를 디자인하는 방법

 

레오나르드 리차드슨(Leonard Richardson) 4단계 모델

 

 

https://jaehoney.tistory.com/176

 

 

🔗REST 성숙도 모델 - 0단계

 

REST API를 작성하기 위한 기본 단계

리소스 구분 없이 HTTP 프로토콜을 사용하기만 해도 가능하다

 

하나의 End-point를 사용해서 HTTP Method도 반드시 POST가 된다

 

 

사용예시)

 

Reqest : 유저를 요청하면

POST /api/user
{
  "function": "getUser",
  "arguments" [
    "1"
  ]
}

Resposne : 코드는 200과 함께 요청을 받고

HTTP/1.1 200 OK
{
  "result" {
    "id": "1"
    "name": "honey",
  }
}

CRUD : HTTP Method도 반드시 POST가 된다

CREATE : POST /api/user
READ :   POST /api/user
UPDATE : POST /api/user
DELETE : POST /api/user

 

 

🔗REST 성숙도 모델 - 1단계

 

리소스 개념을 도입

모든 요청을 하나의 엔드포인트(네트워크에 연결하고 네트워크를 통해 통신하는 모든 디바이스)로 보내는 것

이 아니라 개별 리소스와 통신

요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것

 

HTTP Method는 GET과 POST만 사용하고 코드는 200으로 전달

 

 

사용예시)

 

Reqest : 선택한 유저의 유무를 물어보면

POST /api/users/create
{
  "name": "honey"
}

Resposne : 코드는 200과 함께 요청을 받고

HTTP/1.1 200 OK
{
  "result" {
    "error": "already exist member"
  }
}

CRUD : GET과 POST만 사용

CREATE : POST /api/users/create
READ :   GET /api/users/1
UPDATE : POST /api/users/update
DELETE : POST /api/users/remove/1

 

 

🔗REST 성숙도 모델 - 2단계

 

 

2단계는 CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점

조회(READ) -> GET, 생성(CREATE) -> POST

응답 코드도 201 Created로 명확하게 작성

현재 가장 많은 REST API가 이 단계에 해당

 

 

사용예시)

 

Reqest : 선택한 유저의 유무를 물어보면

POST /api/users/create
{
  "name": "honey"
}

Resposne : 코드는 201과 함께 요청을 받고

HTTP/1.1 201 Created
Content-Type: application/json
{
  "result" {
    "id": "1",
    "name": "honey"
  }
}

CRUD : CREATE/READ/UPDATE/DELETE

CREATE : POST /api/users
READ :   GET /api/users/1
UPDATE : PUT /api/users/1
DELETE : DELETE /api/users/1

 

 

 

🔗REST 성숙도 모델 - 3단계

 

HATEOAS(Hypertext As The Engine Of Application State)

하이퍼미디어 컨트롤을 적용

요청은 2단계와 동일 응답은 URI를 포함한 링크 요소를 삽입하여 작성

응답 내에 새로운 링크를 넣어 새로운 기능을 접근 가능

 

추가적으로 다음 Request에 필요한 End-point까지 제공을 한다. 이는 Uniform Interface의 HATEOAS를 의미

 

 

사용예시)

 

Reqest

GET /api/

Resposne 

HTTP/1.1 200 OK
Content-Type: application/json
{
  "/api/users",
  "/api/users/{userId}/roles",
  "/api/products",
  "/api/..."
}

Reqest

GET /api/users/1

 

Resposne 

HTTP/1.1 200 OK
Content-Type: application/json
{
 "result" {
    "id": "1",
    "name": "honey",
    "_links": {
      "self" : {
        "href" : "https:/api/users/1"
      },
      "update" : {
        "href" : "https:/api/users/1"
      },
      "list" : {
        "href" : "https:/api/users/" // 클라이언트에게 흥미를 끌 수 있는 요소
      },
  }
}

 

 

 

 

📍OPEN API

 

누구에게나 접근 가능한 API(이용 수칙 o, 제한사항 o)

 

 

📍 API Key

API를 이용하기 위해서는 key가 필요

서버 문을 여는 열쇠