학습 목표
- REST API에 대해 이해할 수 있다.
- REST API 문서를 읽을 수 있다.
- REST API에 맞춰 디자인할 수 있다.
- Open API와 API Key에 대해 이해할 수 있다.
- Postman이 무엇인지 이해하고 사용할 수 있다.
- HTTP API 테스팅이 무엇인지 알 수 있다.
- Postman을 사용하여 서버에 GET, POST 요청을 보내고 응답을 받을 수 있다.
👻REST API란?
웹 애플리케이션에서는 HTTP 메서드를 이용해 서버와 통신한다.
클라이언트와 서버 사이에는 데이터와 리소스를 요청하고 요청에 따른 응답을 전달하기 위한 음식점의 메뉴판같은 것이 필요하다. (이를 API가 수행한다.)
👻좋은 REST API를 디자인하는 방법?
REST 성숙도 모델은 총 4단계(0~3단계)로 나누어지지만, 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있다.
이런 경우 HTTP API 라고도 부른다.
0단계 : HTTP 사용
단순히 HTTP 프로토콜을 사용하기만 해도 된다.
하지만 이를 REST API라고 할 수는 없으며, 0단계는 좋은 REST API를 작성하기 위한 기본 단계일 뿐이다.
Ex) 병원을 예약할 떄 예약 가능한 시간을 확인한다고 치자
(요청)
POST /appointment HTTP/1.1
[헤더 생략]
{
“date” : “2022-06-08”,
“doctor” : “안형준”
}
(응답)
HTTP/1.1 200 OK
[헤더 생략]
{
“slots” : [
{“doctor” : “안형준”, “start” : “09:00”, “end” : “12:00”},
{“doctor” : “안형준”, “start” : “14:00”, “end” : “16:00”}
]
}
이렇듯 단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.
1단계 : 개별 리소스와의 통신 준수
모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바이다.
Ex)
(요청)
POST /doctors/안형준 HTTP/1.1
[헤더 생략]
{
“date” : “2022-06-08”,
}
(응답)
HTTP/1.1 200 OK
[헤더 생략]
{
“slots” : [
{“id” : 123, “doctor” : “안형준”, “start” : “09:00”, “end” : “12:00”},
{“id” : 123, “doctor” : “안형준”, “start” : “14:00”, “end” : “16:00”}
]
}
2단계 : HTTP 메소드 원칙 준수
REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
앞서 0단계와 1단계 예시에서는 모든 요청을 CRUD에 상관없이 POST로 하고 있다.
CRUD
Create : post
Read : get
Update : put(전체 수정) / patch(부분 수정)
Delete : delete
CRUD에 맞춰 사용하게 된다면 응답 코드도 POST의 경우 201 Created와 같이 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 해야한다.
Ex)
(요청)
GET /doctors/안형준/slots?date-2022-06-08 HTTP/1.1
[헤더 생략]
(응답)
HTTP/1.1 200 OK
[헤더 생략]
{
“slots” : [
{“id” : 123, “doctor” : “안형준”, “start” : “09:00”, “end” : “12:00”},
{“id” : 123, “doctor” : “안형준”, “start” : “14:00”, “end” : “16:00”}
]
}
GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
POST 는 요청 마다 새로운 리소스를 생성하고 PUT 은 요청 마다 같은 리소스를 반환하는데, 이와 같은 특징을 멱등(idempotent)하다고 한다.
3단계 : HATEOAS 원칙 준수
HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.
Ex)
(요청)
GET /doctors/안형준/slots?date-2022-06-08 HTTP/1.1
[헤더 생략]
(응답)
HTTP/1.1 200 OK
[헤더 생략]
{
“slots” : [
{“id” : 123, “doctor” : “안형준”, “start” : “09:00”, “end” : “12:00”},
{“id” : 123, “doctor” : “안형준”, “start” : “14:00”, “end” : “16:00”}
],
“links” : {
“appointment” : {
“href”:http://localhost:8080/slots/123”,
“method” : “POST”
}
}
}
예를 들어 위와 같이 안형준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다.
이와 같이 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트이다.
👻Open API와 API Key
Open API
정부에서 제공하는 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있다.
글자 그대로 누구에게나 열려있는 API이다. 하지만 기관이나 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.
Ex)날씨 API
API Key
API를 이용하기 위해서는 API Key가 필요하다.
클라이언트의 요청에 따라 서버에서 응답한다는 말은 결국 서버를 운용하는 데에 비용이 발생한다는 말이다.
그렇기에 서버에서는 아무런 조건 없이 데이터를 제공할 의무도, 이유도 없다. (API key가 필요하지 않은 경우도 있다.)
그래서 로그인된 이용자에게만 자원에 접근할 수 있는 권한을 API Key의 형태로 제공되고, 이를 통해 원하는 응답을 받을 수 있다.
👻Postman
HTTP API 테스트 도구
HTTP 요청을 테스트할 수 있는 다양한 도구들을 살펴보자
HTTP API 테스트 도구 (CLI)
* curl (대부분의 리눅스 환경에 내장되어 있습니다.)
* wuzz
HTTP API 테스트 도구 (GUI)
* Postman
* Insomnia
👻Postman 사용하기
GET 요청하기 (Request)
GET /ahnhyungjoon/messages
응답(Response)의 JSON 형식
[
{
"id": 1,
"username": “안형준”,
"text": “코드스테이츠 동기들 파이팅”,
"roomname": "로비",
"date": "2022-06-08 12:00:00"
}
// ...여러 개의 메시지
]
POST 요청하기 (Request)
POST /ahnhyungjoon/messages
응답(Response)의 JSON 형식
{
"id": 5
}오늘은 REST API, Postman 등에 대한 개념을 학습했다.
어제와 같이 분명히 처음에는 어렵다는 느낌이 딱히 없었지만 깊게 공부할수록 내용이 몇배로 많아지는 느낌이였다.
Spring을 학습할 때에 네트워크 개념을 잘 공부해놓고 가야 학습할 때 수월하다는 말을 들어 최대한 꼼꼼하게 학습하려고 노력했던 것 같다.
물론 오늘 하루만으로는 완벽하게 외울 수는 없겠지만 헷갈릴 때 마다 블로그를 통해 정리했던 내용들을 찾아볼 생각이다.
오늘 하루 고생 많았고 내일도 파이팅!
개발 공부