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 sur les API REST
Pour aider les clients à comprendre et à utiliser votre API, vous devez documenter cette dernière. Pour vous aider à documenter votre API, API Gateway vous permet d'ajouter et de mettre à jour le contenu de chaque entité de l'API dans le cadre du processus de développement de l'API. API Gateway stocke le contenu source et vous permet d'archiver différentes versions de la documentation. Vous pouvez associer une version de la documentation à une étape de l'API, exporter un instantané de la documentation propre à une étape donnée dans un fichier OpenAPI externe et distribuer le fichier sous forme de publication de la documentation.
Pour documenter votre API, vous pouvez appeler l'API REST API Gateway, utiliser l'un des AWSkits SDK
Pour partager la documentation de l'API avec les développeurs, vous pouvez utiliser un portail pour développeurs. Pour obtenir un exemple, consultez Integrating ReadMe with API Gateway to Keep Your Developer Hub Up to Date
Rubriques
- Représentation de la documentation de l'API dans API Gateway
- Documentation d'une API avec la console API Gateway
- Publication de la documentation de l'API à l'aide de la console API Gateway
- Documentation d'une API en utilisant l'API REST API Gateway
- Publication de la documentation de l'API à l'aide de l'API REST
- Importation de la documentation d'une API
- Contrôle de l'accès à la documentation de l'API
