次の方法で共有

API のテスト、監視、開発のために API 定義を Postman にエクスポートする

適用対象: すべての API Management レベル

API の開発を強化するために、API Management でアクセスされる API を Postman にエクスポートできます。 Postman のツールを使用して API を設計、文書化、テスト、監視、共同作業できるように、API Management から Postman コレクションとして API 定義をエクスポートします。

注

API Management から Postman に直接エクスポートできるのは API 定義のみです。 その他の情報 (ポリシーやサブスクリプション キーなど) はエクスポートされません。

前提条件

API Management インスタンスに移動します。

  1. Azure portal で、 API Management サービスを検索して選択します。

    検索結果に API Management サービスを示すスクリーンショット。

  2. [API Management サービス] ページで、API Management インスタンスを選択します。

    [API Management サービス] ページの API Management インスタンスを示すスクリーンショット。

Postman に API をエクスポートする

  1. ポータルの [API] で、API を選択します。

  2. コンテキスト メニュー (...) で、[エクスポート]>[Postman] を選択します。

  3. [Run in] (実行先) ダイアログで、エクスポート先の Postman の場所を選択します。 デスクトップ アプリをローカル側にインストール済みである場合は、デスクトップ アプリのオプションを選択できます。

  4. Postman で、API をインポートする先の Postman ワークスペースを選択します。 既定値は [マイ ワークスペース] です。

  5. Postman で、[Generate collection from this API] (この API からコレクションを生成する) を選択して、API 定義からコレクションを自動的に生成します。 必要に応じて、詳細なインポート オプションを構成するか、既定値をそのまま使用します。 [インポート] を選択します。

    コレクションとドキュメントが Postman にインポートされます。

    Postman にインポートされたコレクションのスクリーンショット。

API Management と Postman を使用する API 開発

API 開発者は、Postman の API テスト、監視、開発の機能を使用して API の変更作業をイテレーション方式で迅速に行うことができます。

Postman で開発された API を、エクスポートして API Management に API リビジョンとしてインポートすることができます。 これを利用すると、API を Postman で開発してから実行時アクセスと管理のために API Management に展開することができます。 詳細情報

注意事項

API Management のサブスクリプション キーやその他の機密データを Postman の中で渡すときは注意してください。 Postman Vault を使用して、機密データを vault シークレットとして Postman のインスタンス内で保存することをお勧めします。これで、シークレットを安全にコレクションと要求で再利用できるようになります。

関連するコンテンツ