REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말합니다.
먼저 어제 클라이언트와 서버가 통신할때 클라이언트가 서버에 잘 명령할수있게 보여주는 메뉴판 역활을하는것이 API라고했다. REST API는 간단하게 잘만든 메뉴판이고
우리는 메뉴판을 잘만드는 방법에대해서 이야기해볼꺼다.
요순서대로 잘지키면 잘만든 API가 되는데 단계별로 살짝 자세하게 보자.
0단계
REST 성숙도 모델에 따르면, 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 됩니다.
그래서 뭐 별게없음. 사실 그냥 사용하자..
1단계
웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현한다고 이야기했습니다. 따라서 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심입니다.
=>엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법입니다.
2단계
CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둡니다.
HTTP 메서드를 사용할 때 몇가지 규칙에도 유의하셔야 합니다.
GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 합니다.
POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환합니다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 합니다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 합니다.
PUT 메서드와 PATCH 메서드도 구분하여 사용해야 합니다. PUT은 교체, PATCH는 수정의 용도로 사용합니다.
3단계
HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용합니다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 합니다.
Open API
이 API에는 "Open"이라는 키워드가 붙어 있습니다. 글자 그대로 누구에게나 열려있는 API입니다. 그러나 "무제한으로 이용할 수 있다"라는 의미는 아닙니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있습니다.
API Key
API를 이용하기 위해서는 API Key가 필요합니다. API key는 서버의 문을 여는 열쇠입니다. 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없습니다. (가끔 API key가 필요하지 않은 경우도 있습니다.)
간단하게 요약하자면 API는 클라이언트와 서버간의 소통창구인데 이를 잘만드려면
첫쨰 http 이용 두번쨰 리소스와의 연결을 잘할것 세번쨰 적절한 http 메서드를쓸것
네번째 링크를활용해 적절하게 볼수있게할것
Open API는 공공기관에서 제공하는 공용API지만 이용수칙에맞게 활용할것.
API Key는 API사용하기위한 KEY이다.
