웹페이지 to Web API

해결하고 싶은 문제

서비스 중인 웹페이지와 타 서비스를 연동해야 한다. Web API를 제공하고 싶지만 운영 중인 웹페이지를 수정하거나 별도의 API서비스를 구축하는 것이 부담스럽다.

솔루션/패턴 설명

M2 를 이용해 <HTML> 웹 페이지를 JSON 으로 실시간 맵핑한다.

../../_images/dgm018.png

Endpoint 를 이용해 RESTful하게 API를 제공한다.

장점/효과

  • 즉시 가용한 API 서비스를 제공한다.

  • 웹페이지가 수정되면 API에 즉시 반영된다.

  • 백엔드를 연동할 필요가 없다.

주의점

신규 API 서비스 구축비용의 경제성을 면밀히 따져야 한다. 만약 <HTML> 을 처리하는 과정에 복잡한 컨텍스트나 비지니스 로직이나 필요하다면 구축이 더 나은 방법일 수 있다.

기타

소스 <HTML> 이 수정되는 경우 Mapper 를 수정할 수도 있지만 엔드포인트로 제공하는 Web API의 버전을 관리하는 것도 좋은 방법이다.

http://example.com/v1/product/info.json
http://example.com/v2/product/info.json
http://example.com/product/v1/info.json
http://example.com/product/v2/info.json