API Gateway 中 REST API 的文件

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

若要記載您的 API，您可以呼叫 API Gateway REST API、使用其中一個 AWS SDK、使用 AWS CLI for API Gateway，或使用 API Gateway 主控台。此外，您可以匯入或匯出外部 OpenAPI 檔案中定義的文件組件。

若要與開發人員共用 API 文件，您可以使用開發人員入口網站。如需範例，請參閱 AWS 合作夥伴網路 (APN) 部落格上的整合讀我檔案與 API Gateway，讓 Developer Hub 保持最新狀態，或請參閱如何使用 SmartBear 的 SwaggerHub 簡化 Amazon API Gateway 上的 API 開發。