역 스파아토 웹 서비스의 API Tester 앱을 Electron으로 만드는 이야기.

발 연구소 Advent Calendar 2016 , 13일째는 Electron 에 역 스파아토 Web API의 API Tester적인 앱을 작성해 보려고 합니다.

API Tester

Slack API 문서 등은 참조와 함께 API Tester을 제공하며 매개 변수를 지정하여 실제 WebAPI 응답을 얻을 수 있습니다.

WebAPI를 사용할 때 매개변수 조합과 응답을 신속하게 시도할 수 있다면 개발 효율이 향상될 것입니다. 그래서, 바로 역 스파아토 Web API의 간단한 API Tester를 작성해 보았습니다.

APT Tester의 샘플 코드는 GitHub에 UP되어 있습니다. WebAPI 액세스 키는 "역 스파아토 웹 서비스"에서 신청하여 얻을 수 있습니다.

valsitoh/val_sample

Electron이 설치된 환경의 경우 샘플 코드를 git clone 한 후 다음 명령으로 실행할 수 있습니다.
(Electron 설치 지침은 12일째 기사을 참조하십시오)

$ git clone https://github.com/valsitoh/val_sample.git
$ cd val_sample
$ electron ./api_tester

역 스파아토 Web API Tester

동작 이미지는 다음과 같은 느낌입니다. 각 API에 대해, 파라미터(전부 설정할 수 있도록 하는 시간이 없었기 때문에 일부만입니다만...)를 지정해, "Test WebAPI"를 실행하면 리스폰스를 취득할 수 있습니다.



예를 들면 이런 느낌이군요.



다른 WebAPI에 대해서도 마찬가지로 API를 테스트할 수 있습니다. 이것은 역 간이 정보 응답을 얻는 예입니다.



데이터 버전 얻는 예제입니다. 역 스파아토 웹 서비스Document에도 설명되어 있지만 응답은 XML, JSON 중 하나에서 얻을 수 있습니다.



모처럼 Electron 으로 어플리케이션을 작성하고 있으므로 환경 변수로부터 액세스 키를 취득·설정하고 싶은 곳입니다만, 지금은 매번 입력하는 느낌입니다.

요약

Slack의 API Tester에서 힌트를 얻고 역 스파아토 웹 API의 간단한 API Tester를 작성해 보았습니다. 웹 서비스Documents의 매개 변수 설명을 참조하면서 WebAPI를 시도하면 더 이해할 수 있습니다.