前回のブログ記事では、Design Automation API for Revit の基本的な仕組み、用語、開発手順について解説いたしました。
今回は、実際の API について、Postman サンプルで動作を確認するためのセットアップ手順をご紹介します。
Postmanは、Web API ( RESTful API ) をテストするときに役立つツールです。
各種 OS 向けのクライアントアプリケーションや、 Chromeの拡張機能ツールとして提供されており、これらのツールを使用すれば、プログラムコードを作成することなく、HTTP リクエスト・レスポンスを確認することができます。
Web API をはじめて利用する際には、いきなり Webアプリケーションの開発を始めるのではなく、このようなツールを活用して、実際に API の動作を確認することで理解を深めることができます。
以前、このブログ記事でも Postman による RESTful API のテストについてご紹介しました。
ここで簡単に Web API のおさらいをしておきましょう。
Web API のリクエストを実行すると、その API のエンドポイントを提供しているサーバーに対して何らかのアクションを実行できます。
これらのアクションは HTTP メソッドという形で定義されております。
最も一般的なアクションは、GET、POST、PUT、および DELETEです。
たとえば、GETを使用すると、サーバーからデータを取得できます。POSTを使用すると、サーバー内の既存のファイルまたはリソースにデータを追加できます。PUTを使用すると、サーバー内の既存のファイルまたはリソースを置き換えることができます。また、DELETEを使用すると、サーバーからデータを削除できます。
Postman は、この Web API のリクエストを簡単に送信するツールです。
Design Automation API for Revit のドキュメントページでは、この Postman のサンプル（ベータ版）を Postman コレクションという形で公開しております。
このドキュメントページに掲載されているセットアップ方法をご紹介します。
1. Postman のインストール
インストールの手順は下記の Postman 公式ドキュメントをご参照ください
2. Forge アプリの作成と Client ID と Client Secret の取得
Postman サンプルを利用するためには、Forge アプリを作成する必要があります。
Forge ポータルサイトでこれから作成する Forge アプリを登録して、 Forge Platform API の利用に必要な Client ID と Client Secret を取得します。この処理は、手動でおこなう必要があります。具体的な手順は、過去のブログ記事を参考にしてください。
3. Postman Collection の入手とインポート
下記のリンクから Postman Collection をダウンロードして、Postman アプリケーションでインポートします。Postman アプリケーションの左上の Import ボタンを押すと、インポートダイアログが表示されます。先ほどダウンロードした Collection ファイルを選択します。
Postman Collection とは、Postman で作成した Web API の複数の HTTP リクエストをコレクションとしてまとめて JSON 形式のテキストファイルで書き出したものです。
インポートが完了すると、下記のようにサイドバーにコレクションが表示されます。
4. Postman Environment の入手とインポート
下記のリンクから Postman Environment をダウンロードして、Postman アプリケーションでインポートします。先ほどと同じインポートダイアログで Environment ファイルを選択します。
複数の HTTP リクエストで共通して利用するパラメータは、環境変数のような形式で管理することができ、これも Postman Environment として、同じ形式のテキストファイルで保存できます。
インポートした Postman Environment をドロップダウンリストから選択し、クイックルックツールで確認します。
5. 環境変数の設定
クイックルックで表示されている大ログの右上の Edit ボタンを押すと、MANAGE ENVIRONMENTS ダイアログが表示されるので、Client ID と Client Secret を設定します。
またここで、ニックネームも設定することができます。ニックネームはグローバルで一意でなければなりません。他のユーザーに既に使用されている場合は、そのニックネームを使用することはできません。
6. Revit アドイン バンドルパッケージの準備
Revit アドインのバンドルパッケージを用意します。
もしまだ Revit アドインをお持ちでない場合、あらかじめ用意されているサンプルのアドインをダウンロードして使用することができます。
※右側のリンクからダウンロードした場合、システムの都合上、ファイル名が全て小文字になってしまいます。お手数をおかけしますが、それぞれ左のファイル名に名前を変更してご利用ください。
- SketchItApp.zip（リンクが切れている場合は こちら からダウンロードできます。）
- CountItApp.zip（リンクが切れている場合は こちら からダウンロードできます。）
- DeleteWallsApp.zip（リンクが切れている場合は こちら からダウンロードできます。）
これで Postman サンプルの準備は完了です。
次回はこの Postman サンプルを使って動作を確認してみましょう。
By Ryuji Ogasawara
Subscribe
コメント