Documentación para las API de REST en API Gateway

Para ayudar a los clientes a comprender y utilizar la API, debe documentar la API. Para ayudar a documentar su API, API Gateway le permite agregar y actualizar el contenido de la ayuda de las distintas entidades de API como parte integral de su proceso de desarrollo de la API. API Gateway almacena el contenido de origen y le permite archivar diferentes versiones de la documentación. Puede asociar una versión de la documentación a una etapa de la API, exportar una instantánea de documentación específica de la etapa a un archivo de OpenAPI externo y distribuir el archivo como una publicación de la documentación.

Para documentar la API, puede llamar a la API de REST de API Gateway, utilizar uno de los AWS SDK, la AWS CLI para API Gateway o usar la consola de API Gateway. Además, puede importar o exportar las piezas de la documentación definidas en un archivo de OpenAPI externo.

Para compartir la documentación de la API con los desarrolladores, puede usar un portal para desarrolladores. Para ver un ejemplo, consulte Integrating ReadMe with API Gateway to Keep Your Developer Hub Up to Date o How to Streamline API Development on Amazon API Gateway Using SmartBear’s SwaggerHub en el blog de Red de socios (APN) de AWS.