これまで本ブログでForgeのDesign Automationについて、サンプルやチュートリアル等を交えてご紹介をしてきたかと思いますが、InventorでのDesign Automationについては概要のご紹介に留まっていたかと思います。
今回より、複数回に分けて、InventorでのDesign Automationのサンプルをご紹介していきたいと思います。
今回は、InventorのDesign Automation APIをPostmanで動作を確認するための、Postman環境のセットアップ手順をご紹介いたします。
ご存知のように、Postmanは、HTTPリクエストをGUIを用いて簡単に送信し、Web APIの動作の確認をすることのできるツールとなります。
Design Automation API for Inventorのチュートリアルでは、動作を確認するのに便利な、事前定義済みのHTTPリクエストのサンプルを Postman コレクションという形で公開しております。
Postman コレクションは、タスクでグループ化されており、各タスクはDesign Automation API for Inventorのチュートリアルでの各タスクと同じ名前となっております。
また、同様にタクス内の各リクエストは、チュートリアルでの各ステップと同じ名前が付けられています。
なお、本記事では、Postmanコレクションのセットアップにあたり、以下は完了しているものといたします。
- Postmanのインストール
- 必要となるForge アプリの作成と Client ID と Client Secret の取得
もし、Forgeアプリの作成と、Client ID と Client Secret の取得をされていない場合は、以下の過去のブログ記事を参考に設定と取得をお願いいたします。
1.Postman environmentの入手とインポート
Postman environmentは、複数のHTTPリクエスト間で共通的に利用する値を格納する、名前付きのコンフィグレーションです。例としては、Forgeにリクエストを行う際のアクセストークンは、環境変数dapAccesssTokenに格納され、各HTTPリクエストで利用ができます。
以下の手順に従い、チュートリアル向けのPostman environmentをインポートしてください。
- DA4Inventor-Environment.postman_environmentファイルをダウンロード
- ダウンロードしたDA4Inventor-Environment.postman_environment.jsonファイルをPostmanにインポート
- Postmanアプリケーションのヘッダーバーから、インポートをクリックしダイアログを表示
- ダウンロードしたファイルを、ダイアログにドラッグアンドドロップ
- アプリケーション右上のEnvironmentドロップダウンから、DA4Inventorを選択し環境設定をロード
2.チュートリアル用のPostman コレクションのインポート
Postmanコレクションは事前設定済みのHTTPリクエストのセットです。
以下の手順に従い、チュートリアル向けのPostman コレクションをインポートしてください。
- DA4Inventor Tutorial.postman_collectionをダウンロードファイルをダウンロード
- ダウンロードしたDA4Inventor Tutorial.postman_collection.jsonファイルをPostmanにインポート
- Postmanアプリケーションのヘッダーバーから、インポートをクリックしダイアログを表示
- ダウンロードしたファイルを、ダイアログにドラッグアンドドロップ
アプリケーションの左側に、インポートしたタスクが表示されます。
以上でPostman サンプルの準備は完了となります。
次回は、この Postman サンプルを使って動作の確認したいと思います。
By Takehiro Kato
コメント
コメントフィードを購読すればディスカッションを追いかけることができます。