eBest xing api를 http json으로 요청 응답 하기

 

이베스트투자증권에서 제공하는 xing api를 사용자가 접근하기 쉬운 json 메시지로 요청 및 응답 받는 오픈소스를 소개 한다.  buycycle 모듈을 기동하면 그 모듈이 리슨하고 있는 포트로 json 요청 응답을 할 수 있다. 

 

https://opensource.buycycle.name 

buycycle.name

 

  해당 모듈은 Spring Boot 기반이며, Vue.js로 구현된 웹환경의 API 명세 및 테스트 할 수 있는 웹페이지도 함께 제공하고 있다.  해당 모듈은 오픈소스이므로 github.com/malchooni/buycycle에 접근하면 소스를 확인 할 수 있다.

 

  buycycle의 프로세스는 두가지로 구분 할 수 있는데 조회성 단일 이벤트(xa query)의 경우 HTTP POST(restful)로 json 메시지를 요청하면 그 결과를 json 메시지로 응답 받는다.  실시간성 데이터(xa real)일 경우 websocket을 연결하여 실시간 수신 이벤트를 웹소켓을 통해 제공 받는다.  buycycle은 xing api의 구현체를 내포하고 있어 사용자는 HTTP 클라이언트 및 웹소켓 클라이언트를 구현하여 서비스를 제공 받는다.

 

  buycycle은 모듈 기동시 웹화면을 같이 제공하는데 그 웹화면에선 xing api 에서 제공하는 인터페이스 목록과 해당 인터페이스의 상세 명세도 확인 할 수 있다.  또한 웹화면엔 HTTP 클라이언트 및 웹소켓 클라이언트도 같이 구현되어있어 사용자가 참조할 수 있고 테스트 또 한 가능하다.

 

  다음 동영상을 통해 buycycle의 동작을 엿볼 수 있다.

youtu.be/rD5R_XTzDis

 

  다운로드는 buycycle.name에 접속하여 '다운로드' 메뉴를 통해 github release 페이지에서 buycycle.zip 바이너리 파일을 다운 받는다.  다운 받은 파일은 압축을 풀어 buycycle/config/application.yaml 파일에 아이디 비번 정보를 저장 후 startBuycycle.bat 실행을 통해 기동할 수 있다.