ITエンジニア/デザイナ向けにオープンソースを毎日紹介

SwaggerはRESTfulなWeb APIのテスト環境。Web上で実行して結果を確認できる。

SwaggerはScala製のオープンソース・ソフトウェア。Web APIが十分に普及してきたことで、何気なくWeb APIを利用できるようになってきた。TwitterやFacebookはその最たるものだが、小さなものとしてはフィードを取り込むようなものも数多く使われている。


Web API一覧

Web APIでは提供形式としてRESTfulなものが最も多くなっている。RESTfulなWeb APIを使ってシステム開発を行う際に、どう言う風にコールしてどう返って来るのか、それを実験できるのがSwaggerだ。

SwaggerはWebベースで利用するソフトウェアで、Web APIのエンドポイントになるURLの一覧に加えて、そのメソッド、そしてコールするための変数名を一覧で表示する。後は変数名の横にあるテキストボックスに値を入れて、実際にコールすることが可能だ。


実行結果

入力必須かどうか分かるようになっていたり、APIキーを使う場合にも入力できるようになっている。コールした結果のステータスコードや、レスポンスも見やすく表示される。各APIについて、スキーマ的な設定が必要ではあるが、自社で提供しているWeb APIのデモ実行環境として提供するのも良さそうだ。


MOONGIFTはこう見る

Web APIとはローカルアプリケーションで言うDLLみたいなもので、実際に処理されている内容はブラックボックスになっている。正しくメッセージを送れれば問題がないが、間違った時に適切なエラーメッセージが返って来ないとデバッグに非常に時間を費やしてしまうのが難点だ。

Swaggerのようなデモ環境を用意することで、間違ったコールなのか否かすぐに分かるのが良い。このようなデモ環境を用意するのはWeb API提供側としては利用者増に大きく貢献することだろう。WebサービスがWeb APIを提供するのが当たり前になってきた現在(日本ではその点がまだまだ立ち後れているが)、その実行環境についても適切な準備をしておこう。

via Document Your REST APIs with Style | Web Resources | WebAppers

Swagger: A simple, open standard for describing REST APIs with JSON

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2