Publicado: Dec 1, 2016
Agora você pode adicionar documentação aos métodos e recursos de APIs usando o Amazon API Gateway, o que facilita a compreensão da sua API pelos consumidores. É possível adicionar documentação para sua API diretamente usando o console, a ILC e o SDK do API Gateway, ou simplesmente especificá-la usando tags de documentação na definição Swagger da API. Também é possível reutilizar a documentação em aspectos comuns de sua API. Por exemplo, você pode criar a documentação padrão de erros apenas uma vez e usá-la em várias respostas de API sem duplicar o conteúdo atual, acelerando a documentação de suas APIs e eliminando erros de "copiar e colar" que podem surgir com strings duplicadas. Depois de publicada como parte de um estágio da API, você pode exportar a documentação usando o recurso de exportação do Swagger e disponibilizá-la em seu portal do desenvolvedor.
O API Gateway fornece a você fluxos de trabalho independentes para definição e documentação da API. Isso permite que os desenvolvedores de APIs e escritores técnicos trabalhem em paralelo e importem o Swagger deles separadamente usando o console, a ILC e o SDK.
Para obter mais informações, consulte Como documentar uma API do API Gateway.