Swagger Editor で REST API を試す (1)

開発者PCの環境

ここでは Swagger Editor を使った Wagby の REST API 接続を紹介します。Swagger Editor は開発者によく知られている REST API 動作検証ツールです。

クラウド上のWagby

Wagbyはクラウド上で動作しています。契約時に割り当てられる開発環境https://[お客様].dev.wagby.comを使います。

Swagger Editor

開発者のPCにインストールし、起動します。https://[お客様].dev.wagby.com/wagby に接続します。

Webブラウザ

タブを切り替えて使います。一つ目のタブはhttps://[お客様].dev.wagby.com/wagbyを直接、開きます。ビルドしたWagbyアプリケーションを操作できます。
もう一つのタブは（開発者PCで起動中の)Swagger Editorにつなげます。URLはhttp://localhost:8080/になります。

Swagger Editorを起動する

Docker が利用できる開発環境で、次のコマンドを実行してください。

docker run --name swagger -d -it --rm -p 8080:8080 swaggerapi/swagger-editor

Dockerイメージがダウンロードされたあと、ポート 8080 で Swagger Editor が起動します。

起動したら、Webブラウザに新しいタブを用意し、次の URL を入力します。

http://localhost:8080

Swagger Editor の画面が開きます。Fileメニューから "Clear editor" を選び、環境をクリアします。

Open API フォーマット

REST API を利用するモデルについて、Wagby は API 仕様を「Open API フォーマット」で提供します。

Wagby Designer のタブに切り替えます。運用メニューから「その他 > 開発環境 > REST API 仕様」の「コピー」ボタンをクリックします。

Swagger Editor のタブに切り替えます。左側の空白部分に、コピーした Open API フォーマットを「ペースト」します。(CTRLキーとVキーを使ってペーストできます。）

Servers の欄がhttps://[お客様].dev.wagby.com/wagbyとなっていることを確認してください。これ以降の操作は、この開発環境への REST 呼び出しになります。

ここまでの操作で Wagby の REST API を Swagger Editor から確認し、試すことができるようになりました。

認証

Wagbyが提供するREST APIを試すには、事前に認証手続きを行う必要があります。

はじめに、Swagger Editor に用意された「Authorize」ボタンをクリックします。

cookieAuth と autoLogonAuth の二系統があります。autoLogonAuth を使います。

REST 呼び出し行うユーザーIDとパスワードをコロンで区切ったものを BASE64 で符号化（エンコード）したものを指定します。

Valueの部分を入力し「Authroize」ボタンをクリックしてください。

BASE64符号化文字列の作成方法

Googleなどの検索エンジンで "base64 エンコード" などで検索するとさまざまなツールやネット上のサービスがみつかります。いずれかの方法をご利用ください。

例えばユーザー admin, パスワード wagby の組み合わせ "admin:wagby" を BASE64 で符号化すると "YWRtaW46d2FnYnk=" となります。

なお、admin (管理者) のパスワードはお使いの開発環境ごとに定められています。

認証後は「Close」ボタンをクリックしてこのダイアログを終了します。なお「Logout」ボタンをクリックすると認証が解除されます。