張貼日期: Dec 1, 2016
現在您可將文件新增到使用 Amazon API Gateway 為 API 建立的方法和資源,以便您的 API 消費者了解 API。您可以直接使用 API Gateway 主控台、CLI 和 SDK 為您的 API 新增文件,或只需在 API 的 Swagger 定義內使用文件標籤進行指定。您也可以跨 API 的通用方面重複使用文件。例如,您可以只編寫一次標準錯誤文件,然後在多個 API 回應中使用,而無需刪除重複的實際內容,以便更快記錄您的 API 且可消除使用重複字串產生的「複製貼上」錯誤。您的文件作為 API 階段的一部分發佈後,您可以使用 Swagger 匯出功能將其匯出,並使其可在您的開發人員入口網站中使用。
API Gateway 針對 API 定義和 API 文件為您提供獨立的工作流程。這可讓 API 開發人員和技術文件撰寫人員並行工作,並使用主控台、CLI 和 SDK 單獨匯入其 Swagger。
如需詳細資訊,請參閱記錄 API Gateway API。