Publicado en: Dec 1, 2016
Ahora puede agregar documentación a los métodos y recursos de las API creadas con Amazon API Gateway, lo cual facilita que los consumidores de API las comprendan. Puede agregar documentación para su API directamente mediante la consola, la interfaz de línea de comandos (CLI) y el SDK de API Gateway, o simplemente especificarla mediante etiquetas de documentación dentro de la definición de Swagger de la API. También puede reutilizar documentación sobre los aspectos comunes de su API. Por ejemplo, puede crear documentación sobre errores estándar solo una vez y utilizarla en diversas respuestas de API sin duplicar el contenido real, con lo cual resulta más rápido documentar sus API y se eliminan los errores de “copiar y pegar” que pueden producirse cuando se duplican cadenas. Después de publicar la documentación como parte de una fase de API, puede exportarla mediante la característica de exportación de Swagger y ponerla a disposición en su portal de desarrollador.
API Gateway proporciona flujos de trabajo independientes para la definición de API y la documentación de API. Esto permite a los desarrolladores de API y los redactores técnicos trabajar en paralelo e importar su Swagger de forma independiente mediante la consola, la CLI y el SDK.
Para obtener más información, consulte Documentación de una API REST en API Gateway.