🌐 API 설계-HATEOAS

HATEOAS 기반 REST API

HATEOAS(Hypermedia as the engine of application state)는 REST Application Architecture를 다른 Network Application Architecture와 구분짓는 중요한 제약 조건 중 하나입니다.

클라이언트는 애플리케이션 서버가 동적으로 제공하는 Hypermedia 정보를 이용해야 합니다. 서버는 응답(Response)할 때 관련 리소스 링크나 다음에 수행할 수 있는 작업 링크를 제공합니다.

여기서 Hypermedia란 간단히 이야기해서 사용자가 텍스트, 이미지, 동영상 및 기타 미디어를 클릭하여 새 웹 페이지를 여는 것을 말합니다.

HATEOAS의 장단점

HATEOAS를 적용하면 응답 데이터의 가독성이 향상되고 리소스 간의 관계를 관리할 수 있습니다. 그러나 응답 데이터가 리소스 URI와 의존성을 갖게 되며, 구현이 다소 까다로울 수 있습니다.

HATEOAS 적용 예제

GET /accounts/12345 HTTP/1.1
Host: bank.example.com

HTTP/1.1 200 OK

{
    "account": {
        "account_number": 12345,
        "balance": {
            "currency": "usd",
            "value": 100.00
        },
        "links": {
            "deposits": "/accounts/12345/deposits",
            "withdrawals": "/accounts/12345/withdrawals",
            "transfers": "/accounts/12345/transfers",
            "close-requests": "/accounts/12345/close-requests"
        }
    }
}

References
https://en.wikipedia.org
https://restfulapi.net
https://sddev.tistory.com