開発者ポータルの概要

開発者ポータルは、自動的に生成され、完全にカスタマイズ可能な、API のドキュメントが含まれる Web サイトです。 API コンシューマーはここで API を見つけ、使用方法を確認し、アクセスを要求し、試すことができます。

この記事で紹介しているように、特定のシナリオに合わせて開発者ポータルをカスタマイズし、拡張することができます。

API Management developer portal

可用性

重要

この機能は、API Management の PremiumStandardBasicDeveloper レベルで使用できます。

従来のポータルから移行する

重要

従来の開発者ポータルは非推奨となり、セキュリティ更新プログラムのみを受け取るようになりました。 2023 年 10 月に廃止され、すべての API Management サービスから削除されるまでは、通常どおりに引き続き使用できます。

新しい開発者ポータルへの移行については、専用のドキュメント記事で説明されています。

カスタマイズとスタイル設定

開発者ポータルは、ドラッグ アンド ドロップで操作できる組み込みのビジュアル エディターを使用して、カスタマイズおよびスタイル設定できます。 詳細については、このチュートリアルを参照してください。

機能拡張

API Management サービスには、常に最新の組み込みのマネージド開発者ポータルが含まれています。 Azure portal インターフェイスからアクセスできます。

既定ではサポートされていないカスタム ロジックを使用して拡張する必要がある場合は、そのコードベースを変更できます。 ポータルのコードベースは、GitHub リポジトリで入手できます。 たとえば、サードパーティのサポート システムと統合する新しいウィジェットを実装できます。 新しい機能を実装する場合は、次のいずれかのオプションを選択できます。

  • API Management サービスの外部で、実装後のポータルをセルフホストします。 ポータルをセルフホストする場合、管理者が保守を行う必要があり、アップグレードの責任を負うことになります。 Azure サポートによる支援は、セルフホステッド ポータルの基本的なセットアップのみに限定されます。
  • マネージド ポータルのコードベースに新機能をマージするように、API Management チームに対してプル要求を開きます。

拡張性に関する詳細および手順については、GitHub リポジトリと、ウィジェットの実装に関するチュートリアルを参照してください。 マネージド ポータルのカスタマイズのチュートリアルに関するページでは、ポータルの管理パネルについて説明しています。これは、マネージド バージョンとセルフホステッド バージョンで共通です。

次のステップ

新しい開発者ポータルの詳細を確認します:

その他のリソースを参照します: