Publié le: Dec 1, 2016
Vous pouvez dorénavant ajouter des documents à vos méthodes et vos ressources pour les API créées à l'aide d'Amazon API Gateway, ce qui permet aux consommateurs de votre API de comprendre plus facilement votre API. Vous pouvez ajouter de la documentation pour votre API directement à l'aide de la console, de la CLI et du kit SDK API Gateway, ou simplement la spécifier à l'aide de balises de documentation dans la définition Swagger de l'API. Vous pouvez également réutiliser la documentation sur des aspects communs de votre API. Par exemple, vous pouvez créer une documentation d'erreur standard une seule fois et l'utiliser dans plusieurs réponses d'API sans dupliquer le contenu réel, accélérant ainsi la documentation de vos API et éliminant les erreurs de « copier-coller » pouvant survenir avec des chaînes dupliquées. Une fois votre documentation publiée dans le cadre d'une étape de l'API, vous pouvez l'exporter à l'aide de la fonctionnalité d'exportation Swagger et la rendre disponible dans votre portail de développeur.
API Gateway vous fournit des flux de travail indépendants pour la définition et la documentation de l'API. Cela permet aux développeurs d'API et aux rédacteurs techniques de travailler en parallèle et d'importer leur Swagger séparément à l'aide de la console, de la CLI et du kit SDK.
Pour plus d'informations, consultez la section Documenter une API Amazon API Gateway.