[로드맵] API 설계 원칙

HATEOAS(Hypermedia As The Engine Of Application State)

HATEOAS는 RESTful 아키텍처의 제약 조건으로, 클라이언트가 응답에서 제공된 하이퍼미디어 링크를 통해 API를 동적으로 탐색할 수 있도록 한다. URL이나 엔드포인트를 하드 코딩하는 대신, 클라이언트는 웹 브라우저가 웹페이지의 링크를 따라가는 것처럼 이러한 링크를 통해 사용 가능한 작업을 발견한다. 이를 통해 더 큰 유연성을 제공하고 클라이언트를 서버 측 변경 사항에서 분리하여 기존 클라이언트를 중단하지 않고도 시스템을 보다 적응적이고 확장 가능하게 만든다.

이는 REST의 무상태 원칙과 자체 설명적 메시지의 핵심 요소이다.

 

OpenAPI Specification(OAS)

OpenAPI Specification(OAS)은 이전에 Swagger로 알려졌으며 RESTful API를 정의하고 문서화하기 위한 표준이다.

API 엔드포인트, 요청 및 응답 형식, 인증 방법 및 기타 메타데이터를 설명하는 YAML 또는 JSON의 구조화된 형식을 제공한다. OAS를 사용하면 개발자는 클라이언트 생성, 자동화된 문서화 및 테스트를 용이하게 하는 포괄적이고 기계에서 읽을 수 있는 API 설명을 만들 수 있다. 이 사양은 API 설계의 일관성과 명확성을 촉진하고, 다양한 시스템 간의 상호 운용성을 향상시키며, 도구가 클라이언트 라이브러리, 서버 스텁 및 대화형 API 문서를 생성할 수 있도록 한다.