[Network] Rest API

2022.12.02

💡 Rest API

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

• 정확한 소통을 위한 최소한의 규칙 -> 좋은 TMI를 해주면 된다.

📌 Rest API 디자인

Rest API를 작성할 때 몇 가지 지켜야할 규칙들이 있다.

REST API 설계 규칙

REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있다.

• URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.
• 마지막에 슬래시 (/)를 포함하지 않는다.
• 언더바 대신 하이폰을 사용한다.
• 파일확장자는 URI에 포함하지 않는다.
• 행위를 포함하지 않는다.

REST API의 좋은 디자인 방법

리차드슨은 4가지 단계의 모델을 만들었고 이를 구조화하면 아래와 같다.

Rest 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 물론 이경우를 Rest API라고 부를 수 없지만 그 출발점이라고 보면 된다.

허준이라는 이름의 주치의의 예약가능 시간을 확인하고, 어떤 특정시간에 예약하는 상황을 예로 들어보면 0단계는 다음과 같다.

Rest 성숙도 모델 - 1단계

1단계에서는 개별 리소스와의 통신을 준비해야 한다고 한다. REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현하기 때문에 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바이다.

어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에 적절한 엔드포인트를 작성하는 것이 중요하다. 엔드포인트 작성 시에는 동사, HTTP 메소드 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직하다.또한 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

REST 성숙도 모델 - 2단계

2단계에서는 CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점을 둔다. 모든 요청을 CRUD에 상관없이 POST로만 작성한다면 당연히 적합한 메소드 사용이 아니다.조회(READ)를 하는 행위에는 GET 메소드를, 생성(CREATE)하는 행위에는 POST 메소드를 사용하여 요청을 보내는 것이 바람직하다.

또 2단계에서는 POST 요청에 대한 응답이 어떻게 반환되는지도 중요하다. 응답이 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 해야한다.이렇게 해야 REST 성숙도 모델의 2단계를 충족한 것이라 볼 수 있다.메소드를 사용할 때의 규칙이 있다.

• GET : 서버의 데이터를 변화시키지 않는 요청에 사용
• POST : 요청마다 새로운 리소스를 생성
• PUT : 요청마다 같은 리소스를 반환매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메소드 PUT과 그렇지 않은 POST는 구분하여 사용해야 한다.
• PATCH : 수정의 용도로 사용 (PUT은 교체의 용도, PUT과 PATCH도 구분해서 사용해야 한다)
• 참고 : MDN HTTP request methods

REST 성숙도 모델 - 3단계

3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다.이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

쉽게 말해 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트다.만약 클라이언트 개발자들이 응답에 담겨져 있는 링크들을 눈여겨본다면 이러한 링크들은 조금 더 쉽고 효율적으로 리소스와 기능에 접근할 수 있게 하는 트리거가 될 수 있다.