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.
APIDocumentation d'importation
Comme pour l'importation de définitions d'APIentités, vous pouvez importer des parties de documentation à partir d'un API fichier Open externe vers une API API passerelle intégrée. Vous spécifiez les parties de la to-be-imported documentation au sein de l'x-amazon-apigateway-documentation objetextension dans un fichier de API définition ouvert valide. L'importation de documentation ne modifie pas les définitions API d'entités existantes.
Vous avez la possibilité de fusionner les parties de documentation nouvellement spécifiées dans les parties de documentation existantes dans API Gateway ou de remplacer les parties de documentation existantes. Dans ce MERGE mode, une nouvelle partie de documentation définie dans le API fichier Open est ajoutée à la DocumentationParts collection duAPI. Si une DocumentationPart importée existe déjà, un attribut importé remplace celui qui existe déjà si les deux sont différents. Les autres attributs de documentation existants ne sont pas modifiés. Dans ce OVERWRITE mode, l'ensemble de la DocumentationParts collection est remplacé conformément au fichier de API définition Open importé.
Importation de parties de documentation à l'aide de la API passerelle REST API
Pour importer de API la documentation à l'aide de la API passerelle RESTAPI, appelez l'opération documentationpart:import. L'exemple suivant montre comment remplacer les parties de documentation existantes d'un par une API GET / méthode unique, en renvoyant une 200 OK réponse en cas de succès.
En cas de réussite, cette demande renvoie une réponse 200 OK contenant la DocumentationPartId importée dans la charge utile.
{ "ids": [ "kg3mth", "796rtf", "zhek4p", "5ukm9s" ] }
En outre, vous pouvez également appeler restapi:import ou restapi:put, en fournissant les parties de documentation de l'x-amazon-apigateway-documentationobjet dans le fichier Open d'entrée de la définition. API API Pour exclure les parties de la documentation de l'APIimportation, définissez ignore=documentation les paramètres de requête.
Importation de parties de documentation à l'aide de la console API Gateway
Les instructions suivantes expliquent comment importer des parties de la documentation.
Pour utiliser la console pour importer des parties de documentation API d'un fichier externe
-
Dans le volet de navigation principal, choisissez Documentation.
-
Choisissez Import (Importer).
-
Si vous avez de la documentation existante, sélectionnez Remplacer ou Fusionner votre nouvelle documentation.
-
Choisissez Choisir un fichier pour charger un fichier à partir d'un lecteur ou entrez le contenu d'un fichier dans l'affichage de fichier. Pour obtenir un exemple, consultez la charge utile de l'exemple de demande dans Importation de parties de documentation à l'aide de la API passerelle REST API.
-
Choisissez comment gérer les avertissements lors de l'importation. Sélectionnez Échouer avec les avertissements ou Ignorer les avertissements. Pour plus d’informations, consultez Erreurs et avertissements liés à l'importation de votre fichier API dans API Gateway.
-
Choisissez Import (Importer).
