駅すぱあとWebサービスのドキュメントサイトにSwaggerを適用してさらに使いやすく!

こんにちは。 駅すぱあとWebサービス フリープランドキュメントサイトにSwaggerを適用しました。

f:id:hiiiiiiihikaru:20170701175357p:plain

docs.ekispert.com

これにより、駅すぱあとWebサービスのWebAPIを、より試しやすく、より理解しやすくなったのではないかと思います。 なので今回は、Swaggerとは何なのか、どう便利になったのかをお話しします。

駅すぱあとWebサービスとは

国内初の乗換案内ソフト「駅すぱあと」がもつ様々な情報をWebAPIで提供しているサービスです。 経路探索はもちろん、駅データや時刻表などの情報を取得できます。 無料で使えるフリープランを用意しており、企業にかぎらず個人でも利用できます。

ekiworld.net

docs.ekispert.com

Swaggerとは

Swaggerとは、設計からテスト、デプロイ、ドキュメント生成を可能にするAPI開発ツールです。

swagger.io

どう便利になったの?

Swaggerを適用したことによって、APIを簡単に試すことができるようになりました。

駅すぱあとWebサービスAPIは、一つのAPIで出来ることが多い半面、 気軽にAPIを叩きたくても、リファレンスをじっくり読まないといけなかったりします。 例えば駅情報APIのパラメータ数は認証用のキーをのぞいて13個あったりします。その中で必須のパラメータはどれなのか探すのは結構面倒臭いです😅 あと、リファレンスを読みながらパラメータを入力してボタンぽちっと押すだけで試せるのは、ブラウザでurlを叩くよりも面倒がなくて良いですよね。

こちらのページから試すことができます。

気軽にAPIを試せるようになることで、ユーザのAPI学習コストを下げることに貢献するのではないかと期待しています。

APIに接続するためのアクセスキーを各自で取得しないとAPIを試すことはできませんので、その点にご留意ください。 アクセスキーは、「駅すぱあとWebサービス フリープラン」お申し込みフォームのページで無料で取得することができますので、お気軽にお申し込みください。

終わりに

駅すぱあとWebサービスのドキュメントサイトでSwaggerを適用したら、こんな風に便利になったよ、という話でした。 まだ フリープランのドキュメントにしか対応していなくて、スタンダードプランの方には対応できていないんですけど、様子を見てこちらも適用しようと思っています。