API Gateway ポータル - Amazon API Gateway
考慮事項

API Gateway ポータル

API Gateway ポータルを使用して、ウェブページで API および API ドキュメントを API コンシューマーと共有できます。ポータルには、一連のポータル製品が含まれています。各ポータル製品は REST API の論理グループであり、API コンシューマー用に作成して公開するドキュメントが含まれています。ポータル内の製品ページには、ポータルの製品レベルでのカスタムドキュメントが含まれています。製品 REST エンドポイントページには、各 REST API のドキュメントと、REST API のパス、メソッド、ステージが含まれています。製品ページと製品 REST エンドポイントページの組み合わせにより、API コンシューマーが REST API の使用を開始する方法を学習できる完全なドキュメントが提供されます。

ポータルを使用して以下を実行します。

  • API の作成からドキュメント化、配布まで、API ライフサイクル全体に API Gateway を使用します。

  • AWS アカウント間でポータル製品を共有します。

  • ポータル製品の一元的な場所をカスタマイズして共有し、製品ページを提供します。

考慮事項

以下の考慮事項は、API Gateway ポータルの使用に影響する可能性があります。

  • ポータルは、REST API を共有するためにのみ作成できます。

  • ポータルは AWS リージョンレベルで作成されます。ポータルには、ポータルを作成するリージョンと同じリージョンにある REST API のみを含めることができます。

  • ポータルの作成と共有には AWS マネジメントコンソール、AWS CLI、または AWS SDK のみを使用できます。

  • ポータルへのアクセスは、Amazon Cognito ユーザープールを使用してのみ制御できます。ポータルコンシューマーは、ユーザープール経由で直接サインインするか、サードパーティーの ID プロバイダー (IdP) 経由でフェデレーション方式で認証を行うことができます。Amazon Cognito ユーザープールを使用する場合、ユーザープールのクライアントシークレットを設定することはできません。詳細については、「Amazon Cognito ユーザープール」を参照してください。