[개발자되기: REST API ] Day-29

Kyoorim LEE·2022년 6월 10일
0

REST API

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

REST 성숙도 모델

REST 성숙도 모델 - 0단계

HTTP 프로토콜을 사용하기만 해도 OK

REST 성숙도 모델 - 1단계

REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현함
-> 모든 자원은 개별 리소스에 맞는 Endpoint를 사용해야하고 요청하고 받는 자원에 대한 정보를 응답으로 전달해야함

  • Endpoint 작성 시 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직함

요청에 따른 응답으로 리소스 전달 시 사용한 리소스 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야함

REST 성숙도 모델 - 2단계

2단계까지 적용하면 잘 작성된 API라고 할 수 있음
CRUD에 맞는 적절한 HTTP 메서드 사용이 관건
ex) 0단계, 1단계 모두 CRUD와 상관없이 POST 사용

HTTP 메서드 사용 시 지켜야 할 규칙

  • GET 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용
  • POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환 => 멱등(idempotent)성을 가지는 PUT과 그렇지 않은 POST는 구분해서 사용
  • PUTPATCH 구분해서 사용

REST 성숙도 모델 - 3단계

HATEOAS(Hypertext As The Engine Of Application State)
HATEOAS원칙 준수한 API
3단계의 요청은 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성
ex) 병원 예약 시, 예약 가능 시간 확인 후에 그 시간대에 예약할 수 있는 링크 삽입 or 예약 완료 후 그 예약을 다시 확인할 수 있는 링크 삽입

Open API

정부에서 제공하는 공공데이터를 쉽게 접근할 수 있도록 정부에서 Open API를 제공
ex) 날씨 정보(https://openweathermap.org/api)

API Key

API를 이용하기 위해 필요한 서버의 문을 여는 열쇠
자원에 접근할 수 있는 권한

profile
oneThing

0개의 댓글