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.
Exporter un REST API fichier depuis API Gateway
Une fois que vous avez créé et configuré un fichier REST API dans API Gateway, à l'aide de la console API Gateway ou autrement, vous pouvez l'exporter vers un API fichier ouvert à l'aide de API Gateway ExportAPI, qui fait partie d'Amazon API Gateway Control Service. Pour utiliser le API Gateway ExportAPI, vous devez signer vos API demandes. Pour plus d'informations sur les demandes de signature, consultez la section AWS APIDemandes de signature dans le guide de IAM l'utilisateur. Vous avez la possibilité d'inclure les extensions d'intégration API Gateway, ainsi que les extensions Postman
Note
Lorsque vous exportez le fichier à l'APIaide du AWS CLI, veillez à inclure le paramètre extensions comme indiqué dans l'exemple suivant, afin de garantir que l'x-amazon-apigateway-request-validatorextension est incluse :
aws apigateway get-export --parameters extensions='apigateway' --rest-api-id abcdefg123 --stage-name dev --export-type swagger latestswagger2.json
Vous ne pouvez pas exporter un API fichier si ses charges utiles ne sont pas de application/json ce type. Si vous essayez, vous obtiendrez une réponse d'erreur indiquant que les modèles JSON corporels sont introuvables.
Demande d'exportation d'un REST API
Avec l'exportationAPI, vous exportez un existant REST API en soumettant une GET demande, en spécifiant le dans le to-be-exported API cadre des URL chemins. La demande URL est au format suivant :
Vous pouvez ajouter la chaîne de extensions requête pour indiquer si vous souhaitez inclure les extensions API Gateway (avec la integration valeur) ou les extensions Postman (avec la postman valeur).
En outre, vous pouvez définir l'Accepten-tête pour application/json ou pour application/yaml recevoir la sortie de API définition YAML au format JSON ou au format, respectivement.
Pour plus d'informations sur l'envoi de GET demandes à l'aide de API Gateway ExportAPI, consultez GetExport.
Note
Si vous définissez des modèles dans votreAPI, ils doivent être destinés au type de contenu « application/json » pour que API Gateway puisse exporter le modèle. Sinon, API Gateway renvoie une exception avec le message d'erreur « Seulement des modèles non JSON corporels trouvés pour... ».
Les modèles doivent contenir des propriétés ou être définis comme un JSONSchema type particulier.
Télécharger REST API Ouvrir API la définition dans JSON
Pour exporter et télécharger un fichier REST API dans Open API Definitions au JSON format :
Ici, <region>us-east-1, par exemple. Pour toutes les régions où API Gateway est disponible, voir Régions et points de terminaison.
Télécharger REST API Ouvrir API la définition dans YAML
Pour exporter et télécharger un fichier REST API dans Open API Definitions au YAML format :
Télécharger la API définition REST API ouverte avec les extensions Postman dans JSON
Pour exporter et télécharger REST API des API définitions ouvertes JSON au format Postman in :
Télécharger la API définition REST API ouverte avec intégration de API Gateway dans YAML
Pour exporter et télécharger un fichier REST API au YAML format Open API Definitions avec intégration de API Gateway :
Exporter REST API à l'aide de la console API Gateway
Après avoir déployé le REST API vôtre sur un stage, vous pouvez procéder API à l'exportation du stage vers un API fichier ouvert à l'aide de la console API Gateway.
Dans le volet Stages de la console API Gateway, choisissez Stage actions, Exporter.
Spécifiez un type de API spécification, un format et des extensions pour télécharger votre API API définition ouverte.
