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.
Création d'un point de terminaison REST du produit dans API Gateway
Un point de terminaison REST du produit est un point d'accès à votre produit de portail. Chaque point de terminaison comprend le chemin et la méthode d'une API REST et l'étape sur laquelle elle est déployée. Le point de terminaison inclut toute documentation que vous avez définie pour votre API REST, ou peut être mis à jour avec une documentation personnalisée. Lorsque vous créez le point de terminaison REST de votre produit, vous configurez les paramètres suivants :
-
Nom de l'opération du point de terminaison REST du produit. Si votre API REST possède le chemin et la méthode
GET /pets, dans un portail, le nom est/pets. À l'aide du nom de l'opération, vous pouvez remplacer le nom du point de terminaison REST du produit parPet summaries. Cela n'a aucun impact sur votre API existante. -
La fonctionnalité d'essai pour le point de terminaison de votre produit. Cela permet aux utilisateurs d'API de tester votre APIs application sur votre portail. Si vous créez un point de terminaison de produit pour une API privée, la fonctionnalité d'essai est définie sur
UNAVAILABLE. Pour de plus amples informations, veuillez consulter Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail. -
Si des parties de documentation sont actuellement définies pour votre API REST, vous pouvez soit importer la documentation, soit remplacer votre documentation existante et créer une nouvelle documentation au niveau du produit à l'aide GitHub de Flavored Markdown.
Les modifications de documentation ne sont pas répercutées dans les parties de la documentation de votre API API Gateway. Si vous importez les parties de votre documentation actuelle, API Gateway synchronise les modifications apportées à votre API avec le point de terminaison REST de votre produit.
Création d'un point de terminaison REST du produit
La procédure suivante montre comment ajouter un point de terminaison REST de produit à un produit de portail existant. Pour savoir comment créer ensemble un produit de portail et un point de terminaison REST de produit, voirCréation d'un produit de portail dans API Gateway.
Pour créer un point de terminaison REST de produit pour un portail de produit
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
Dans le volet de navigation principal, sélectionnez Portal products.
Choisissez un produit de portail.
Choisissez l'onglet Points de terminaison associés, puis choisissez Ajouter des points de terminaison.
-
Pour sélectionner les points de terminaison REST de votre produit, sous Points de terminaison d'API, choisissez une API, puis choisissez une étape.
Pour ajouter un point de terminaison aux points de terminaison REST de votre produit, sélectionnez le point de terminaison de l'API, puis choisissez Ajouter au produit.
Le point de terminaison de l'API apparaîtra dans la liste des points de terminaison de l'API sélectionnés.
Sélectionnez Envoyer.
-
La page de point de terminaison REST de votre produit est désormais un brouillon. Choisissez Draft API reference pages, puis choisissez la page de point de terminaison REST de votre produit pour finaliser le contenu de la page.
Choisissez Modifier la page.
-
Pour remplacer la documentation existante d'API Gateway, dans le champ Source de documentation, activez l'option Remplacer la documentation et procédez comme suit :
Pour Afficher le contenu, choisissez Create override.
Dans Nom de l'opération, entrez un nouveau nom d'opération.
Pour le corps de la page, entrez votre documentation personnalisée.
-
(Facultatif) Pour Endpoint, entrez un point de terminaison personnalisé qui apparaît sur votre portail.
-
Pour permettre aux clients d'invoquer votre API sur votre portail, sélectionnez la fonctionnalité Essayer. Pour de plus amples informations, veuillez consulter Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail.
-
Dans Nom de section, entrez un nom ou choisissez une section existante. Lorsque vous ajoutez le point de terminaison REST de votre produit à une section, les consommateurs peuvent consulter votre contenu sur un portail publié.
Sélectionnez Enregistrer les modifications.
Pour que la nouvelle page soit visible par les consommateurs, vous devez tout de même republier votre portail. Pour de plus amples informations, veuillez consulter Publier un portail dans API Gateway.
