[HTTP/네트워크] REST API

• REST API

source: https://res.cloudinary.com/practicaldev/image/fetch/s--YTDTEgpk--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev-to-uploads.s3.amazonaws.com/i/ekawmj3rafdtn06hzj79.png

• REST: “Representational State Transfer”의 약자
• 로이 필딩 (Roy Fielding)의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개된 개념
• 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식

 

 

 

• REST 성숙도 모델

https://devopedia.org/richardson-maturity-model

• 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장 
  BUT 엄밀히 3단계까지 지키기 어려워서 2단계까지만 적용해도 좋은 REST API 디자인이라고 볼 수 있음

0단계	HTTP 프로토콜 사용 (그러나 이 단계에서는 REST API라고 부르기에는 부족)
1단계	개별 리소스와의 통신을 준수 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하며, 요청하고 받는 자원에 대한 정보를 응답으로 전달 엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양 리소스에 집중해 명사 형태의 단어로 작성
2단계	CRUD에 맞게 적절한 HTTP 메서드 사용 GET 메서드 : 서버의 데이터를 변화시키지 않는 요청에 사용 POST 메서드 : 요청마다 새로운 리소스를 생성 PUT 메서드 : 요청마다 같은 리소스를 반환 -> 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)성이라고 함. ✨ 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드 POST는 구분하여 사용 ✨ PUT 메서드 : 교체 PATCH 메서드 : 수정 두 메서드도 구분하여 사용 필수
3단계	HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 중요

 

 

 

• Open API

source: https://www.vworld.kr/dev/v4dv_apiuse_s001.do

•  "Open"이라는 키워드가 붙어 있으며 글자 그대로 누구에게나 열려있는 API
• "무제한으로 이용할 수 있다"라는 의미는 X
  API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 존재할 수 있음
  ex) https://openweathermap.org/api , https://www.data.go.kr/ (공공데이터포털)

 

 

 

• API Key

source: https://www.wallarm.com/what/api-key-meaning-what-is-it-and-what-is-it-for

• API 이용을 위해 필요
• 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공하지 않음
  (그러나 가끔 API key가 필요하지 않은 경우도 있음)
• API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고,
  데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있음