Documentation pour REST APIs in API Gateway - APIPasserelle Amazon

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.

Documentation pour REST APIs in API Gateway

Pour aider les clients à comprendre et à utiliser API le vôtre, vous devez documenter leAPI. Pour vous aider à documenter votreAPI, API Gateway vous permet d'ajouter et de mettre à jour le contenu d'aide pour API des entités individuelles dans le cadre de votre processus de API développement. APIGateway stocke le contenu source et vous permet d'archiver différentes versions de la documentation. Vous pouvez associer une version de documentation à une API étape, exporter un instantané de documentation spécifique à l'étape vers un API fichier Open externe et distribuer le fichier en tant que publication de la documentation.

Pour documenter votreAPI, vous pouvez appeler la APIpasserelle REST API, utiliser l'une des passerelles AWS SDKs, utiliser la API passerelle AWS CLIfor ou utiliser la console API Gateway. En outre, vous pouvez importer ou exporter les parties de documentation définies dans un API fichier Open externe.

Pour partager de API la documentation avec les développeurs, vous pouvez utiliser un portail dédié aux développeurs. Par exemple, consultez Integrating ReadMe with API Gateway to Keep Your Developer Hub à jour ou How to Streamline API Development on Amazon API Gateway SmartBear SwaggerHub Using sur le blog AWS Partner Network (APN).

Rubriques