API閘道RESTAPIs中的文件

若要協助客戶瞭解和使用您的API，您應該將API. 為了協助您記錄您的文件API，APIGateway 可讓您新增和更新個別API實體的說明內容，做為API開發程序不可或缺的一部分。APIGateway 會儲存來源內容，並可讓您封存不同版本的文件。您可以將文件版本與階段產生關聯，將API階段特定的文件快照匯出至外部「開啟」API 檔案，然後將檔案作為文件的發行版散佈。

若要記錄您的檔案API，您可以呼叫API閘道RESTAPI、使用其中一個AWS SDKs、用AWS CLI於API閘道，或使用API閘道主控台。此外，您可以匯入或匯出外部「開啟」檔案中定義的文件集零API件。

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

主題

• API網關中的API文檔表示
• API使用API閘道主控台記錄
• 使用API閘道主控台發佈API文件
• API使用API閘道記錄 REST API
• 使用API閘道發佈API文件 REST API
• 匯入API文件
• 控制API閘道中API文件的存取