cURL、Postman ツールを使用してネットワーク API を操作する方法

ゲッティイメージズ

API により、業界におけるネットワークエンジニアの作業方法が簡素化されています。彼らは、スマートフォンやスマートウォッチから国際宇宙ステーションや世界中のデータセンターに至るまで、ハイテクの世界を統治しています。

以前に API を使用したことがあるエンジニアは、コマンドラインインターフェイス (CLI) と無限の構文が使用されていた従来の時代には戻らないでしょう。これらの構文では、ネットワークの停止や企業の収益損失につながるエラーが発生することがよくあります。 API は新しい CLI です。

ネットワーク API の使用例に関する前回の記事では、API とは何か、その使用例、および一流のサービスを提供するために俊敏性が鍵となる世界でネットワークエンジニアが API を採用する必要がある理由について概説しました。この記事では、ネットワークエンジニアが cURL や Postman などのツールを使用してネットワーク API と対話する方法について説明します。

ほとんどのネットワークエンジニアは、さまざまなネットワーキングコミュニティや開発者コミュニティで cURL と Postman について聞いたことがあるでしょう。 Postman は、世界中で 2,000 万人以上のユーザーを持つ GUI ベースの API テストプラットフォームです。開発者が API を設計、構築、テストし、反復を繰り返しながら改善するのに役立ちます。このツールを使用すると、テスト環境と運用環境での API ワークフローが簡素化されます。

コマンドラインツール cURL は、サーバーとの間でデータを送受信するために使用されます。このツールは、マルチプロトコルのサポート (特に HTTP と HTTPS) などの豊富な機能を備えているため、広く使用されています。

Postman と cURL を使用するには、ネットワークエンジニアはインフラストラクチャと対話するためにどの HTTP 動詞を使用するかを決定する必要があります。そのための 1 つの方法は、HTTP 動詞をリンクして、データベースが使用する読み取り、更新、削除 (CRUD) 関数を作成することです。

役職

作成する

得る

読む

置く

アップデート

パッチ

アップデート

消去

ネットワーキングでは、セキュアシェル (SSH) は、ネットワークデバイスへの安全なリモートアクセスのために広く使用されているプロトコルです。しかし、ネットワークデバイスの自動化と API の使用のニーズが高まっているため、ネットワークエンジニアはプログラム可能な方法でデバイス API と対話するためのインターフェイスを必要としています。

HTTP または HTTPS プロトコルは、それぞれ CLI および GUI ツール (cURL や Postman など) を使用してネットワークデバイス API と対話できます。これらの対話により、データを取得したり、データを操作したりできます。ネットワーキング分野では、データのほとんどはデバイス構成です。これらのツールは、エンジニアがネットワークデバイスを他のネットワーク管理システムと統合し、ネットワーク効率を向上させ、ネットワークプロセスを自動化するのに役立ちます。

それでは、cURL と Postman の両方を使用して、HTTPS 経由でデバイス API を操作してみましょう。注: すべての API に共通する CRUD 操作を通じて、デバイス API ドキュメントを明確に理解する必要があります。

以下の例は、ネットワークエンジニアがサンドボックスまたは運用環境で cURL と Postman GUI を使用できるさまざまなシナリオを示しています。

タスクには次のものが含まれます。

ネットワークエンジニアは、スイッチやルーターなどのネットワークデバイスに常にログインする必要があります。これを行うには、エンジニアはサンドボックス CLI を使用してリモートネットワークにアクセスし、IP アドレスを使用してログインします。以下の例では、次のコマンドを使用して、HTTPS 経由で IP アドレス 172.31.0.1 のルーターにログインします。

ここで、「-k」は Secure Sockets Layer 認証を無視し、「-u」はユーザー名とパスワードを示すために含まれています。

cURL は複数のプロトコルをサポートしているため、cURL を使用すると、ネットワークデバイスにリモートでアクセスする効果的な方法になります。

次のステップでは、プライマリアドレス、説明、転送情報などのインターフェイス情報を収集します。この情報は、ネットワークエンジニアがネットワークを分析およびトラブルシューティングする際に役立ちます。

Cisco デバイスのインターフェイスを検査するには、エンジニアは通常、次の Cisco IOS コマンドを使用します。

エンジニアは cURL を使用して同じタスクを実行できます。 1 つのオプションは、JSON でインターフェイス情報を取得することです。現在、JSON データ形式はデータ交換の標準として使用されており、多くのプログラミング言語やツールが JSON データ形式をサポートしています。 JSON は人間が判読可能であり、機械も解析可能です。そのため、エンジニアは、API と統合したり、ネットワーク自動化で使用したりするために、JSON 形式のインターフェイス情報が必要になる場合があります。

エンジニアは、次のコマンドを使用して JSON 受け入れヘッダーを追加することで、JSON でインターフェイス情報を収集できます。

ネットワークエンジニアは、日常および毎月の業務の中で変化するニーズに遭遇します。場合によっては、ルーター構成の編集やインターフェース IP アドレスの変更が必要になる場合があります。

この例では、エンジニアが cURL コマンドを使用して CLI 経由で IP アドレスを変更する方法を示します。ほとんどの場合、ネットワークエンジニアは SSH を使用してデバイスにリモートアクセスします。ただし、新しいネットワーク標準とツールでは、次の cURL コマンドなどの代替手段が提供されています。

ネットワークエンジニアは、Postman GUI を使用して Cisco サンドボックスルータの 1 つと接続できます。このツールは、多くの場合、cURL に比べて使いやすいです。

エンジニアは、トラブルシューティングを行うため、またはルーターの構成を確認するために、インターフェイスのステータスをチェックする必要がある場合があります。この場合、HTTPS プロトコル経由で Postman GUI を使用できます。

ここでは、Postman リクエストバーで次のコマンドを使用して、GET 動詞を使用して情報を取得するか、READ アクションを実行します。

GET - https://172.31.0.1/restconf/data/Cisco-IOS-XE-native:native/interface

Postman の [認証] タブと [ヘッダー] タブに移動してパラメータを入力し、正確な情報を確保します。

ネットワークエンジニアは、POST メソッドを使用してインターフェイスを操作できます。

POST - https://172.31.0.1/restconf/data/Cisco-IOS-XE-native:native/interface

以下の例では、Postman GUI を使用してインターフェイスの IP アドレスを変更する、HTTPS 経由の構成編集機能を示します。

ネットワークの専門家は、PATCH メソッドを使用して、HTTPS プロトコルと Postman 経由でインターフェイスを変更したりシャットダウンしたりできます。 Postman の [本文] タブには、インターフェイスをシャットダウンするために必要な設定が JSON 形式で含まれている必要があります。

ネットワークエンジニアは、たとえばチームが一定期間使用する必要がない場合、ルーターまたはスイッチのインターフェイスを非アクティブ化できます。インターフェイスをシャットダウンすることは、セキュリティを強化するためにドアをロックするようなものです。

以下の例では、エンジニアが一般的に CLI を使用して実行するタスクを Postman で操作する方法を示します。エンジニアに必要なのは、Postman リクエストバーに示されているように、HTTP 経由でサンドボックスにアクセスするための資格情報だけです。

Postman のユニークな機能は、Postman ツールから関数を実行するための Python コードのスニペットを取得できる機能です。 Python は使いやすさ、柔軟性、ライブラリとフレームワークの豊富なセットのおかげで非常に一般的なコーディング言語であるため、エンジニアは多くの場合、ネットワークインフラストラクチャを管理および運用するためのコードを入手する必要があります。

エンジニアは Postman から Python コードを入手して、プロジェクトの要件に応じて使用する際の手作業の労力を軽減し、俊敏性を高めることができます。

完璧なツールはありません。ネットワーク API を使用する場合、cURL と Postman の両方に利点と課題があります。たとえば、cURL は初心者には適していますが、ユーザーはリクエストを保存できません。一方、Postman はあらゆるプログラミング言語をサポートしていますが、大量の RAM を使用します。

以下は、cURL と Postman の長所と短所の内訳です。

業界では、ネットワークエンジニアや開発者がネットワーク API を操作するのに役立つ複数のツールが利用可能です。これらのツールは完璧ではありませんが、エンジニアは自分のニーズに合ったツールを選択でき、仕事を迅速に完了することができます。