開発者ポータルのデプロイを自動化する

  • [アーティクル]

適用対象: Developer | Basic | Basic v2 | Standard | Standard v2 | Premium

API Management 開発者ポータルでは、コンテンツへのプログラムによるアクセスをサポートしています。 これにより、コンテンツ管理 REST API を使用して、API Management サービスとの間でデータをインポートしたりエクスポートしたりすることができます。 REST API アクセスは、マネージとセルフホステッドの両方のポータルで機能します。

自動化された移行スクリプト

API を使用して、テスト環境のサービスと運用環境のサービスなどの 2 つの API Management サービス間で、コンテンツの移行を自動化することができます。 API Management 開発者ポータルの GitHub リポジトリにある scripts.v3/migrate.js スクリプトにより、この自動化プロセスが簡略化されます。

警告

このスクリプトにより、移行先の API Management サービス内の開発者ポータルのコンテンツが削除されます。 それについて不安がある場合は、必ずバックアップを実行してください。

Note

メディア ファイルをホストするカスタム ストレージ アカウントが明示的に定義されたセルフホステッド ポータルを使用している場合 (つまり、config.design.json 構成ファイルで blobStorageUrl 設定を定義した場合) は、元の scripts/migrate.jsスクリプトを使用する必要があります。 元のスクリプトは、メディア ストレージ アカウントが API Management によって管理されているマネージド ポータルまたはセルフホステッド ポータルでは機能しません。 その場合は、代わりに /scripts.v3 フォルダーのスクリプトを使用してください。

このスクリプトは、次のステップを実行します。

  1. ポータルのコンテンツとメディアをソース API Management サービスからキャプチャします。
  2. ポータルのコンテンツとメディアを移行先の API Management サービスから削除します。
  3. ポータルのコンテンツとメディアを移行先の API Management サービスにアップロードします。
  4. 必要に応じて、マネージド ポータルの場合のみ、ポータルを自動的に発行します。

このスクリプトが正常に実行されると、ターゲットの API Management サービスにはソース サービスと同じポータル コンテンツが含まれ、管理者として表示できるようになります。

  • マネージド ポータルを使用している場合は、移行先ポータルを自動発行するようにスクリプトを設定して、移行されたバージョンが訪問者に自動的に提供されるようにすることができます。
  • セルフホステッド ポータルを使用している場合は、移行先ポータルを手動で発行する必要があります。 チュートリアルの発行とホスティングの説明に従って、セルフホステッド開発者ポータルを設定してください。

次の手順

開発者ポータルの詳細については、次を参照してください。