Проведено: Dec 1, 2016
Теперь можно добавлять документацию по методам и ресурсам своих API, созданных посредством Amazon API Gateway, чтобы помочь пользователям разобраться с ними. Добавить документацию API можно, воспользовавшись непосредственно консолью API Gateway, CLI и SDK, либо просто указав ее в виде тегов документации в определении Swagger для API. Также можно повторно использовать документацию, когда это требуется для описания общих аспектов API. Например, вы можете составить единую стандартную документацию по ошибкам, чтобы потом использовать ее во многих ответах API, не дублируя контент. Такой подход ускорит процесс составления документации API и позволит избежать ошибок при копировании и вставке, которые могут быть вызваны дубликатами строк. После того как документация будет опубликована на очередном этапе создания API, ее можно экспортировать с помощью соответствующей функции Swagger и открыть к ней доступ на портале для разработчиков.
API Gateway предоставляет независимые рабочие процессы для составления определений API и его документации. Благодаря этому разработчики API и составители технической документации смогут работать параллельно друг с другом и импортировать данные Swagger по отдельности с помощью консоли, CLI и SDK.
Подробнее см. в разделе Документирование Gateway API.