Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Portails API Gateway
Vous pouvez utiliser un portail API Gateway pour partager votre documentation APIs et celle des API avec les utilisateurs d'API sur une page Web. Un portail contient un ensemble de produits de portail. Chaque produit de portail est un regroupement logique de REST APIs et contient la documentation que vous créez et publiez pour vos utilisateurs d'API. Les pages de produits d'un portail contiennent la documentation personnalisée au niveau du produit du portail. Les pages de point de terminaison REST du produit contiennent la documentation de chacun des REST APIs ainsi que le chemin, la méthode et l'étape d'une API REST. La combinaison des pages produit et des pages de point de terminaison REST du produit fournit la documentation complète permettant aux utilisateurs d'API d'apprendre comment commencer à utiliser votre REST APIs.
Utilisez un portail pour effectuer les opérations suivantes :
-
Utilisez API Gateway pour l'ensemble du cycle de vie de vos API, de leur création APIs à leur documentation et à leur distribution.
Partagez les produits du portail entre différents AWS comptes.
-
Personnalisez et partagez un emplacement central pour les produits de votre portail et fournissez des pages de produits.
Considérations
Les considérations suivantes peuvent avoir un impact sur votre utilisation des portails API Gateway :
Vous ne pouvez créer des portails que pour partager REST APIs.
-
Les portails sont créés au niveau de la AWS région. Votre portail ne peut contenir que des fichiers REST situés dans la même région APIs que celle dans laquelle vous avez créé le portail.
-
Vous ne pouvez utiliser le AWS Management Console AWS CLI, ou que AWS SDKs pour créer et partager vos portails.
-
Vous ne pouvez contrôler l'accès à votre portail qu'à l'aide des groupes d'utilisateurs Amazon Cognito. Les utilisateurs de votre portail peuvent soit se connecter directement par le biais d'un groupe d'utilisateurs, soit se fédérer via un fournisseur d'identité (IdP) tiers. Si vous utilisez un groupe d'utilisateurs Amazon Cognito, vous ne pouvez pas définir de secret client pour votre groupe d'utilisateurs. Pour plus d'informations, consultez la section Groupes d'utilisateurs Amazon Cognito.
