ニフクラmBaaSお役立ちブログ

スマホアプリ開発にニフクラmBaaS。アプリ開発に役立つ情報をおとどけ!

RESTAPIのたたき方を最速で確認する方法

f:id:mbaasblog:20171201093408p:plain

皆さん、mBaaSはどのような環境から使っていますか?スマートフォンのクライアントアプリからだけ使っていないでしょうか?自社システムなど他のサーバーと連携させるときはREST APIを使う必要があり若干ハードルが高いですよね。しかし!mBaaSには「REST APIツール」という簡単にREST APIの使い方が分かるツールがあるのでそちらを使えば、そんな悩みも吹き飛ぶはず・・・っということでこの記事はREST APIツールの使い方をご紹介いたします。

RESTAPIツールってどこにあるの?

まずはREST APIツールがどこにあるかについてご説明です。REST APIツールはダッシュボードから使えます。

f:id:mbaasblog:20171201093408p:plain

上の図の赤丸とクリックすると、下方からREST APIツールが現れます。

f:id:mbaasblog:20171201093528p:plain

今後はこの画面から設定を行いREST APIツールを利用していきます。

REST APIツールの使い方

これからREST APIツールの使い方を3ステップで学んでいきましょう!

1. アプリを選んでAPIキーをセット

まずはAPIキーを設定します。アプリを選ぶだけでAPIキーが設定できます。

f:id:mbaasblog:20171201093606p:plain

上記の入力欄をクリックすると、自身のmBaaS環境にあるアプリが一覧で取得できます。その中のひとつを選んでクリックすると対応するAPIキーが自動で設定できます。

f:id:mbaasblog:20171201093650p:plain

2. 利用機能を選ぶ

「データストア」・「プッシュ通知」などREST APIツールで使える機能が選べます。

f:id:mbaasblog:20171201093731p:plain

上記の入力欄をクリックすると、利用できる機能が一覧で取得できます。

f:id:mbaasblog:20171201093809p:plain

この記事では例としてデータストアのオブジェクト登録を選択します。選択後、クラス名の入力欄が表示されます。

f:id:mbaasblog:20171201093835p:plain

今回はクラス名として「Test」と入力します。オブジェクト登録に必要なクエリ入力を行います。下にスクロールするとコンテントの入力欄が表示されます。

f:id:mbaasblog:20171201093918p:plain

keyとして「test」、valueとして「test」を入力します。

3. 実行と確認

実行は下記のボタンをクリックすることで行えます。

f:id:mbaasblog:20171201093950p:plain

ボタンをクリックした後、下記のポップアップがでますので「実行する」をクリックしましょう。

f:id:mbaasblog:20171201094018p:plain

実行後、データストアにてデータ登録ができているかをご確認ください。

f:id:mbaasblog:20171201094048p:plain

また、下記のタブをクリックすることでREST APIのリクエスト方法も分かります。

f:id:mbaasblog:20171201094128p:plain

curlコマンドでREST APIを叩く場合の方法が記載されていますので、自分でREST APIを叩く場合は参考にしてください。

f:id:mbaasblog:20171201094208p:plain

またリクエストの隣タブで、レスポンスの確認も行えます。

f:id:mbaasblog:20171201094236p:plain

さいごに

今回はREST APIツールの使い方について説明いたしました。今後、自社システムとmBaaSを連携させたいときに活用できるツールですので積極的にご利用ください!