Postman は、REST API を処理するための多目的ツールとして機能します。API の構築、テスト、ドキュメント化、共有に役立ちます。以下は、Postman が提供する主な機能です。
- APIリクエストの作成：Postman は、GET、POST、PUT、DELETE などのさまざまな HTTP メソッドをサポートし、HTTP および HTTPS 経由の API リクエストの生成を容易にします。これにより、ヘッダーや本文などのリクエスト パラメータを簡単に構成できます。
- コレクションのリクエスト：ユーザーは API リクエストをコレクションに整理して、特定のプロジェクトまたは API のリクエストを構造化された方法で管理できます。
- 環境変数とスクリプト：Postman は、動的リクエストに環境変数を利用することを許可し、タスクを自動化するための JavaScript を使用したスクリプト インターフェイスを提供します。
- テストと自動化：Postman を使用すると、API 応答を検証するためのテスト スクリプトの作成と実行が可能になり、正確性が確保され、自動テストがサポートされます。
- リアルタイムのコラボレーションと共有：複数のユーザー間で API リクエスト、環境設定、コレクションをリアルタイムに共有し、共同開発を促進します。
Postman には無料版と有料版 (Pro と Enterprise) があり、後者では拡張機能と共同作業ツールが提供されます。開発者、テスト エンジニア、企業に広く採用されている Postman は、API の開発、テスト、管理を簡素化します。
MIDAS API と Postman
Postman をインストールし、その使用方法を詳しく理解するには、公式 Web サイトにアクセスする必要があります。
Download Postman | Get Started for Free
次に、Postman で CIVIL Open API を使用する手順を説明します。
- CIVIL NX を実行し、新しいファイルを開いて、サーバーに接続します (アプリ → 接続)。
CIVIL NX
- インストールされたPostmanを実行します。
プログラムの実行環境
- REST API を使用するには、まずコレクションを作成する必要があります(フォルダーと同様の概念)。
コレクションの作成
- 新しく作成されたコレクションをクリックし、右側の 3 つのドットを選択して、[リクエストの追加] をクリックします。
コレクションにリクエストを追加
- REST API リクエストを送信するためのウィンドウが作成されました。各コンポーネントは次の役割を果たします。
① HTTP メソッドを設定します(GET、POST、PUT、DELETE)。
② リクエストの URL を入力します。
③ ヘッダーと本文を設定します。
④ リクエストを実行します。
⑤ サーバーから受信した応答を表示します。
リクエスト
- CIVIL NX で新しく開いたファイルから”UNIT”情報を取得します。
① HTTP メソッド
このアクションは情報を”読み取り”するため、次のように HTTP メソッドを”GET”に設定します。
HTTP メソッド
② URL
製品内のベース URL を確認し、コピーします(アプリ → API → API 設定)。
CIVIL NX - API 設定
入力ウィンドウにコピーしたベース URL を入力し、アクセスするデータ URL を次のように追加します。
③ ヘッダーと本文を設定
ヘッダーにはすでに自動生成されたデータが含まれているため、変更する必要はありません。
ヘッダー
次のようにヘッダーを追加します。
- key → MAPI キーを入力
- Value → 上記②図のように商品からコピーして貼り付けます。
MAPI-キーの入力
”GET”および”DELETE”メソッドの場合、Body は必要ありません。
④ UNIT 情報を取得する準備が整いました。”Send” ボタンをクリックします。
⑤ 応答ウィンドウを確認します。
本文には、取得された JSON データが読み取り可能な形式で表示されます。右上隅には、HTTP コード、応答時間、データ サイズが表示されます。
API を通じて取得した情報と実際の製品との整合性を確認します。
- CIVIL NX の新しいファイル内の”UNIT”情報を変更します。
HTTP Method → PUT
URL → Ditto
Header → Ditto
Body
作成 (POST) および変更 (PUT) の場合、リクエストとともに対応する JSON データを送信する必要があります。
[Body] タブにアクセスし、[raw] を選択して、JSON 形式を選択します(下の画像を参照)。
JSON データを使用して、力を KN に、温度を華氏に変更します。次のデータをコピーして、リクエスト本文に貼り付けます。
{
"Assign": {
"1": {
"FORCE": "KN",
"DIST": "M",
"HEAT": "KCAL",
"TEMPER": "F"
}
}
}
”Send”ボタンをクリックして、CIVIL NX データが変更されたことを確認します。
使いやすい
Postman のユーザーフレンドリーなインターフェースと、プログラミングなしで REST API を処理できる機能により、Postman は API と対話する最も迅速な方法の 1 つになります。
無効なJSON形式
さらに、Body セクションの JSON 形式の構文検証や複雑な JSON 構造の自動フォーマットなどの機能により、リクエストの表示と送信が便利になります。
JSON 形式を美しくする
Postman などのツールを通じて MIDAS Open API を調べると、その機能と性能をより深く理解する絶好の機会が得られます。API を実際に操作して体験できるため、機能の理解と使用が容易になります。