# Documentação para APIs REST no API Gateway
<a name="api-gateway-documenting-api"></a>

 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](https://docs.aws.amazon.com/apigateway/latest/api/), usar um dos [AWS SDKs](https://aws.amazon.com/developer/tools/) ou a [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/apigateway/) 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](https://aws.amazon.com/blogs/apn/integrating-readme-with-amazon-api-gateway-to-keep-your-developer-hub-up-to-date/) ou [How to Streamline API Development on Amazon API Gateway Using SmartBear’s SwaggerHub](https://aws.amazon.com/blogs/apn/how-to-streamline-api-development-on-amazon-api-gateway-using-smartbear-swaggerhub/) no blog da Rede de Parceiros da AWS (APN).

**Topics**
+ [Representação da documentação da API no API Gateway](api-gateway-documenting-api-content-representation.md)
+ [Documentar uma API usando o console do API Gateway](api-gateway-documenting-api-quick-start-with-console.md)
+ [Publicar a documentação da API usando o console do API Gateway](apigateway-documenting-api-with-console.md)
+ [Documentar uma API usando a API REST do API Gateway](api-gateway-documenting-api-quick-start-with-restapi.md)
+ [Publicar a documentação da API usando a API REST do API Gateway](api-gateway-documenting-api-quick-start-publishing.md)
+ [Importar a documentação da API](api-gateway-documenting-api-quick-start-import-export.md)
+ [Controlar o acesso à documentação da API no API Gateway](api-gateway-documenting-api-content-provision-and-consumption.md)