本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# API Gateway 中 REST API 的文件
<a name="api-gateway-documenting-api"></a>

 為了協助客戶了解及使用您的 API，您應該記錄 API。為了協助您記錄 API，API Gateway 可讓您新增及更新個別 API 實體的說明內容，這是 API 開發程序不可或缺的一部分。API Gateway 可存放來源內容，並讓您封存不同版本的文件。您可以建立文件版本與 API 階段的關聯、將特定階段的文件快照匯出到外部 OpenAPI 檔案，並在發布文件時分發檔案。

若要記載您的 API，您可以呼叫 [API Gateway REST API](https://docs.aws.amazon.com/apigateway/latest/api/)、使用其中一個 [AWS SDK](https://aws.amazon.com/developer/tools/)、使用 [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/apigateway/) for API Gateway，或使用 API Gateway 主控台。此外，您可以匯入或匯出外部 OpenAPI 檔案中定義的文件組件。

若要與開發人員共用 API 文件，您可以使用開發人員入口網站。如需範例，請參閱 AWS 合作夥伴網路 (APN) 部落格上的[將 ReadMe 與 API Gateway 整合，讓您的開發人員中樞保持在最新狀態](https://aws.amazon.com/blogs/apn/integrating-readme-with-amazon-api-gateway-to-keep-your-developer-hub-up-to-date/)[，或如何使用 SmartBear 的 SwaggerHub 在 Amazon API Gateway 上簡化 API 開發](https://aws.amazon.com/blogs/apn/how-to-streamline-api-development-on-amazon-api-gateway-using-smartbear-swaggerhub/)。

**Topics**
+ [API Gateway 中的 API 文件表示](api-gateway-documenting-api-content-representation.md)
+ [使用 API Gateway 主控台記載 API](api-gateway-documenting-api-quick-start-with-console.md)
+ [使用 API Gateway 主控台發布 API 文件](apigateway-documenting-api-with-console.md)
+ [使用 API Gateway REST API 記載 API](api-gateway-documenting-api-quick-start-with-restapi.md)
+ [使用 API Gateway REST API 發布 API 文件](api-gateway-documenting-api-quick-start-publishing.md)
+ [匯入 API 文件](api-gateway-documenting-api-quick-start-import-export.md)
+ [在 API Gateway 中控制 API 文件的存取](api-gateway-documenting-api-content-provision-and-consumption.md)