[HTTP/네트워크] 실습 (1) - REST API

선정·2022년 6월 10일
Section 2Today I learned
0

Today I Learned

  • REST API

REST API (Representational State Transfer)

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

REST API 성숙도 모델은 4단계로 나뉘며 각 단계를 충족하면 할수록 REST API에 가까워진다. 성숙도 모델의 2단계까지만 적용해도 좋은 API 디자인이라 볼 수 있고, 이렇게 3단계까지 만족하지 못했을 때 REST API가 아닌 HTTP API라고 부르기도 한다.


REST API의 구성

  • 자원(Resource) - HTTP URI
  • 자원에 대한 행위(Verb) - HTTP Method
  • 자원에 대한 행위의 내용(Representations) - HTTP Message Payload

REST API 중심 규칙

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

  • 리소스명은 동사보다는 명사를 사용한다.
  • URI는 자원을 표현하는데 중점을 두어야 한다.
  • get 같은 행위에 대한 표현이 들어가서는 안된다.
# bad
GET /getTodos/1
GET /todos/show/1

# good
GET /todos/1

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

# bad
GET /todos/delete/1

# good
DELETE /todos/1

REST API : REST 아키텍처 스타일을 따르는 API
REST : 분산 하이퍼미디어 시스템(ex. 웹)을 위한 아키텍처 스타일
아키텍처 스타일 : 제약 조건의 집합


REST 성숙도 모델 - 0단계

0단계는 REST API를 작성하기 위한 기본 단계이며, 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 하지만 이것만으로는 해당 API를 REST API라고 할 수 없다.

(예시) 병원 예약 가능 시간 확인

Request

POST /appointment HTTP/1.1
[헤더 생략]

{
  "date: "2022-06-10",
  "doctor: "Pepper"
}

Response

HTTP/1.1 200 OK
[헤더 생략]

{
  "slots": [
    {"doctor": "Pepper", "start": "09:00", "end": "12:00"},
    {"doctor": "Pepper", "start": "14:00", "end": "16:00"}
  ]
}

REST 성숙도 모델 - 1단계

1단계에서는 개별 리소스와의 통신을 준수해야 한다.
모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야 하며 요청하고 받는 리소스에 대한 정보를 응답으로 전달해야 한다.
더불어 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다. 이를 근거로 0단계의 API 예시를 아래와 같이 개선할 수 있다.

(예시1) 병원 예약 가능 시간 확인

  • 개별 리소스에 맞는, 각각 다른 엔드포인트로 구별 ( /doctors/Pepper )

Request

POST /doctors/Pepper HTTP/1.1
[헤더 생략]

{
  "date": "2022-06-10"
}

Response

HTTP/1.1 200 OK
[헤더 생략]

{
  "slots": [
    {"id": 123, "doctor": Pepper, "start": "09:00", "end": "12:00"},
    {"id": 124, "doctor": Pepper, "start": "14:00", "end": "16:00"}
  ]
}

(예시2) 특정 시간에 예약

  • 개별 리소스에 맞는, 각각 다른 엔드포인트로 구별 ( /slots/123 )
  • 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부 반환 (Responses 참고)

Request

POST /slots/123 HTTP/1.1
[헤더 생략]

{
  "patient": "Cola"
}

Response (에약 성공)

HTTP/1.1 200 OK
[헤더 생략]

{
  "appointment" : {
    "slots": {"id": 123, "doctor": Pepper, ... },
    "patient": "Cola"
  }
}

Response (예약 불가, 실패)

HTTP/1.1 409 conflict
[헤더 생략]

{
    "appointmentFailure": {
    "slot": {"id":123, "doctor": "Pepper", ... },
    "patient": "Cola",
    "reason": "해당 시간은 이미 예약되어 있습니다"
  }
}

엔드 포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직하다.


REST 성숙도 모델 - 2단계

2단계에서는 CRUD(Create, Read, Update, Delete)에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다. 이를 근거로 0단계, 1단계의 API 예시를 아래와 같이 개선할 수 있다.

(예시1) 병원 예약 가능 시간 확인

  • CRUD에 맞게 적절한 HTTP 메서드 사용
    => 예약 시간을 조회하는 것은 Read, 이에 적절한 HTTP 메서드는 GET (POST -> GET)
    => GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용해 필요한 리소스를 전달 ( ?date=2022-06-10 )

Request

GET /doctors/Pepper/slots?date=2022-06-10 HTTP/1.1
[헤더 생략]

Response

HTTP/1.1 200 OK
[헤더 생략]

{
  "slots": [
    {"id": 123, "doctor": Pepper, "start": "09:00", "end": "12:00"},
    {"id": 124, "doctor": Pepper, "start": "14:00", "end": "16:00"}
  ]
}

(예시2) 특정 시간에 예약

  • CRUD에 맞게 적절한 HTTP 메서드 사용
    => 예약을 생성하는 것은 Create, 이에 적절한 HTTP 메서드는 POST
    => 이 경우, POST는 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created로 작성 (200 OK -> 201 Created)
    => 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 작성

Request

POST /slots/123 HTTP/1.1
[헤더 생략]

{
  "patient": "Cola"
}

Response (에약 성공)

HTTP/1.1 201 Created
Location: slot/123/appointment
[헤더 생략]

{
  "appointment" : {
    "slots": {"id": 123, "doctor": Pepper, ... },
    "patient": "Cola"
  }
}

HTTP 메서드

  • GET 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
  • POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환(멱등)한다.
  • PUT 메서드는 교체, PATCH 메서드는 수정의 용도로 구분해서 사용해야 한다.

HTTP 메서드CRUD요청 Body응답 Body멱등(idempotent)
GETReadXOO
POSTCreateOOX
PUTUpdateOOO
PATCHUpdateOOX
DELETEDeleteXOO

멱등(idempotent) : 같은 작업을 계속 반복해도 같은 결과가 나오는 것을 의미한다.


REST 성숙도 모델 - 3단계

HATEOAS(Hypertext As The Engine Of Application State)를 충족하기 위해 응답에 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다. 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 한다. 3단계에 따라 이전의 API 예시를 아래와 같이 개선할 수 있다.

(예시1) 병원 예약 가능 시간 확인

  • 요청에 대한 응답을 받은 뒤 할 수 있는 다양한 액션들 컨트롤을 링크 요소에 포함
    => 병원 예약 가능 시간 확인 후 할 수 있는, 해당 시간에 예약하는 기능에 접근할 수 있도록 함

Request

GET /doctors/Pepper/slots?date=2022-06-10 HTTP/1.1
[헤더 생략]

Response

HTTP/1.1 200 OK
[헤더 생략]

{
  "slots": [
    {"id": 123, "doctor": Pepper, "start": "09:00", "end": "12:00"},
    {"id": 124, "doctor": Pepper, "start": "14:00", "end": "16:00"}
  ],
  
  "links": {
    "appointment: {
    	"href": "http://localhost:8000/slots/123",
        "method": "POST"
    }
  }
}

<br / >

(예시2) 특정 시간에 예약

  • 요청에 대한 응답을 받은 뒤 할 수 있는 다양한 액션들 컨트롤을 링크 요소에 포함
    => 병원 예약 후 할 수 있는, 예약 시간 확인 및 예약 취소의 기능에 접근할 수 있도록 함

Request

POST /slots/123 HTTP/1.1
[헤더 생략]

{
  "patient": "Cola"
}

Response (에약 성공)

HTTP/1.1 201 Created
Location: slot/123/appointment
[헤더 생략]

{
  "appointment" : {
    "slots": {"id": 123, "doctor": Pepper, ... },
    "patient": "Cola"
  },
  
  "link": {
    "self": {
        "href": "http://localhost:8000/slots/123",
        "method": "GET"
    },
    "cancel": {
        "href": "http://localhost:8000/slots/123/cancel",
        "method": "DELETE"
    }
  }
}

Open API

정부에서 공공데이터에 쉽게 접근할 수 있도록 공공데이터를 제공하는 형태이다. 공공데이터 포털에서 원하는 키워드를 검색하면 해당 키워드 관련 API를 확인할 수 있다.

Open API이더라도 무제한으로 이용할 수 있다는 의미는 아니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항이 있을 수 있다.


API Key

API를 이용하기 위해서는 서버의 문을 여는 열쇠인, API Key가 필요하다. (가끔 API key가 필요하지 않은 경우도 있다.)
API Key가 필요한 경우, 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있다.


참고

profile
선정
starter
이전 포스트

[HTTP/네트워크] 기초

다음 포스트

[HTTP/네트워크] 실습 (2) - Postman

0개의 댓글