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

웹애플리케이션은 서버와 통신하기 위해 GET POST DELETE 와 같은 HTTP 메소드를 이용해 데이터를 요청하고, 전송하고, 삭제한다. 이때 요청과 응답을 오류없이 정확하게 전달받기 위한 일종의 규약이 존재하는데, 식당에서 메뉴판을 보고 음식을 주문하듯 클라이언트와 서버 사이에도 데이터와 리소스를 요청하고 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하고 이 '일종의 규약' 역할을 API가 수행한다.

레오나르드 리차드슨의 REST API를 잘 적용하기 위한 4단계 모델

0단계 - HTTP사용

• 단순히 HTTP를 사용하는 단계, REST API를 작성하기 위한 기본 단계

1단계 - 개별 리소스와의 통신 준수

• 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 하고 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다
• 엔드포인트 작성 시 동사, HTTP 메소드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성
• 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환

2단계 - HTTP 메소드 원칙 준수

• CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점
  • GET 메소드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용
  • POST 는 요청마다 새로운 리소스를 생성
  • PUT 은 요청마다 같은 리소스를 반환
    • 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다
    • 멱등성을 가지는 메소드 PUT과 그렇지 않은 POST는 구분하여 사용
  • PUT은 교체, PATCH는 수정의 용도로 사용
• 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인 할 수 있도록 해야, 완벽하게 REST 성숙도 모델의 2단계를 충족
• 여기까지 적용될 경우 대체적으로 잘 작성된 API로 여길 수 있다.

3단계 - HATEOAS 원칙 준수

• HATEOAS(Hypertext As The Engine Of Application State)
• 응답에 리소스의 URI를 포함한 링크 요소를 삽입하여 작성
• 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트

Open API와 API Key

Open API

• 'Open' 이라는 키워드 그래도 누구에게나 열려있는 API로 기관이나 API마다 정해진 이용 수칙과 제한 사항(가격, 정보의 제한 등)이 있을 수 있다.
• 공공데이터포털 에 접속해 원하는 키워드를 검색하면, 정부에서 Open API 형태로 제공하는 공공데이터를 확인 가능
• 제한 예시) Open Weather Map에서 제공하는 날씨 API 제한 사항
  • 프리 플랜에서는 기본적으로 분당 60번, 달마다 1백 번 호출이 가능
  • 데이터를 JSON 형태로 응답.

API Key

API Key 는 API를 이용하기 위해 서버의 문을 여는 열쇠. 서버를 운용하기 위해서는 비용이 발생하기 때문에 모든 데이터가 Open API 형태로 제공될 수 없다. 해서 자원에 접근 할 수 있는 권한을 API Key의 형태로 제공하고 데이터를 요청할 때 API Key를 함께 전달하는 이용자에게만 응답한다.