REST API
"Representational State Transfer API"
웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식.
데이터와 리소스를 요청하고, 요청에 따른 응답을 전달하기 위한 메뉴판.
클라이언트는 이 메뉴판을 보고 식사를 주문하듯 데이터를 서버에 '요청'하고,
서버는 메뉴판에 있는 사진이나 음식에 대한 설명과 같은 '응답'을 클라이언트로 전송한다.
따라서 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽게 잘 작성된 메뉴판이 필요한데,
이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요하다.
REST API를 디자인하는 방법
REST API 성숙도 모델 - 0단계
단순히 HTTP 프로토콜을 사용하는 모델. REST API를 작성하기 위한 기본 단계
REST API 성숙도 모델 - 1단계
모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하며, 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.
0단계에서는 요청에서의 엔드포인트로, 모두 /appointment를 사용했다. 하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분해 사용한다.
요청: 허준이라는 의사의 해당 날짜 예약 가능한 시간 / 엔드포인트: /doctors/허준
응답 자원(리소스): 예약 가능한 시간
요청: 특정 시간 예약 / 엔드포인트: /slots/123
응답 자원(리소스): 예약 확인(성공 or 실패)
엔드포인트는 리소스에 집중해서 명사 형태의 단어로 작성
요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.
REST API 성숙도 모델 - 2단계
CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
0단계, 1단계 예시에서는 모든 요청을 CRUD와 상관없이 POST 메서드를 사용해 처리하고 있다.
예약 가능 시간 확인 => READ => GET 메서드 사용
GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스 전달
특정 시간에 예약 => CREATE => POST 메서드 사용
응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created로 명확하게 작성해야 한다.
관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면 2단계를 충족시킨 것.
HTTP 메서드를 사용할 때의 규칙
- GET 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
- POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드 POST는 구분해서 사용해야 한다.
- PUT 메서드와 PATCH 메서드도 구분해서 사용해야 한다. PUT은 교체, PATCH는 수정의 용도로 사용한다.
REST API 성숙도 모델 - 3단계
HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.
요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.
이때 응답에 들어가는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.
예약 가능 시간 확인 => 예약할 수 있는 링크 삽입
예약 완료 => 예약 확인 링크 삽입
Open API
정부에서 제공하는 공공데이터의 형태.
공공데이터 포털에 접속해 원하는 키워드를 검색하면, 해당 키워드와 관련된 API 확인 가능.
공공데이터 포털
국가에서 보유하고 있는 다양한 데이터를『공공데이터의 제공 및 이용 활성화에 관한 법률(제11956호)』에 따라 개방하여 국민들이 보다 쉽고 용이하게 공유•활용할 수 있도록 공공데이터(Datase
www.data.go.kr
누구에게나 열려있지만 무제한으로 이용할 수 있는 것은 아니다.
정해진 수칙이 있고 이용 수칙에 따른 제한사항(가격, 정보의 제한)이 있을 수 있다.
API Key
서버의 문을 여는 열쇠.
API Key가 필요한 경우에는 로그인한 이용자에게 '자원에 접근할 수 있는 권한'을 API Key 형태로 제공하고, 데이터를 요청할 때 API Key를 함께 전달해야 원하는 응답을 받을 수 있다.
'부트캠프 > TIL' 카테고리의 다른 글
| 코드스테이츠 프론트엔드 부트캠프 Day 33. 구조 분해 할당, fetch (0) | 2023.02.02 |
|---|---|
| 코드스테이츠 프론트엔드 부트캠프 Day 31. [HTTP/네트워크] (0) | 2023.01.30 |
| 객체 지향 프로그래밍 (0) | 2023.01.30 |
| Day 26 - fs 모듈, fetch 데이터 불러오기 (2) | 2023.01.19 |
| Day 26 - Promise, Async/Await (0) | 2023.01.19 |