Documentação para APIs REST no API Gateway

Para ajudar os clientes a compreender e usar sua API, você deve documentá-la. Para ajudar você a documentar sua API, o API Gateway permite adicionar e atualizar o conteúdo da ajuda para entidades de API individuais como parte integrante do seu processo de desenvolvimento de APIs. O API Gateway armazena o conteúdo de origem e permite arquivar diferentes versões da documentação. É possível associar uma versão de documentação a um estágio da API, exportar um snapshot da documentação específico de um estágio para um arquivo do OpenAPI externo e distribuir esse arquivo como uma publicação da documentação.

Para documentar uma API, você pode chamar a API REST do API Gateway, usar um dos AWS SDKs ou a AWS CLI para o API Gateway ou usar o console do API Gateway. Além disso, é possível importar ou exportar as partes da documentação definidas em um arquivo OpenAPI externo.

Para compartilhar a documentação da API com os desenvolvedores, você pode usar um portal para desenvolvedores. Por exemplo, consulte Integrating ReadMe with API Gateway to Keep Your Developer Hub Up to Date ou How to Streamline API Development on Amazon API Gateway Using SmartBear’s SwaggerHub no blog da Rede de Parceiros da AWS (APN).