本文旨在介紹如何通過控制台管理REST API的關鍵步驟，包括髮布、匯入匯出、下線API等操作。您還可以在控制台中一鍵產生 SDK 及其使用文檔，從而高效地管理和整合 API，提升開發流程的便利性。
發布API
前提條件
在發布API之前，確保API中已經定義並建立了介面。
操作步驟
雲原生API Gateway提供了執行個體內和執行個體外兩種發布API的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API。單擊右上方的發布。
在發布API面板中配置相關參數，然後單擊發布。
配置項
說明
網域名稱
選擇對應的網域名稱進行發布，發布後，支援通過相關網域名稱訪問API。
若無網域名稱，可單擊添加網域名稱，具體操作，請參見建立網域名稱。
所屬執行個體
選擇所建立的雲原生API Gateway執行個體。不同的業務環境可用不同的執行個體區分，實現API在多環境上的發布。
使用情境
使用情境包括基礎情境和灰階情境兩類。關於目標服務不同類型說明，請參見路由。
基礎情境
Mock：介面的響應將返回介面定義中的Mock配置，若介面未定義Mock配置，則將無法訪問該介面。
說明發布Mock情境時，要求當前API中至少有一個介面開啟了Mock配置，否則將發布失敗。
單服務：所有流量請求將轉寄到某一具體的後端服務（最常使用的情境）。
灰階情境
按比例（多服務）：所有的流量將按比例分發到對應的後端服務中，常用於切流及灰階發布情境。
說明要求多個條目的服務權重之和等於100。
按內容（多服務）：所有的流量將按照匹配條件分發到對應的後端服務中，若匹配條件勾選預設，則無其他匹配規則命中時，流量將進入該條目所對應後端服務。
匹配條件支援：等於、首碼是、正則匹配。
參數類型支援：Query、Header。
多個匹配條件之間為“且”運算邏輯。
重要要求多個條目中，只允許一個條目勾選預設，且其餘條目的匹配條件非空。
標籤路由（按比例）：標籤路由情境，所有流量將按比例分發到多個後端服務的多個版本。全鏈路灰階情境下推薦優先使用單服務路由，以獲得更好的效能與體驗。
後端服務
關聯該網關/VPC下的後端服務。若該網關下無後端服務，可單擊建立服務建立，具體操作，請參考建立服務。
發布描述
填寫API的發布描述。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API。
單擊右上方的發布，在發布API面板中配置相關參數，然後單擊發布。
配置項
說明
執行個體
所建立的雲原生API Gateway執行個體。不同的業務環境可用不同的執行個體區分，實現API在多環境上的發布。
所屬VPC
執行個體介面所屬VPC。
發布範圍
API級介面發布範圍，可以選擇介面名稱查看受影響介面詳情。
發布描述
填寫API的發布描述。
添加API版本
目前只有執行個體外建立的API支援添加版本。
登入雲原生API Gateway控制台。在左側導覽列，選擇API，並在頂部功能表列選擇地區。
單擊目標API，單擊右上方的，完成相關配置：
配置項
說明
使用方式
支援Path、Query、Header三種方式。
說明選擇使用方式為Query時，需要配置參數項添加Query。
選擇使用方式為Header時，需要配置參數項添加Header。
使用Path時，需要添加完整訪問路徑為：/API基本路徑/版本號碼/介面路徑。
使用Query時，完整訪問路徑為：/API基本路徑/介面路徑，請求參數中需要配置參數項添加Query為版本號碼。
使用Header時，完整訪問路徑為：/API基本路徑/介面路徑，要求標頭中需要配置參數項添加Header為版本號碼。
（可選）在添加完成後，您可以單擊頁面上方的版本以進行版本切換。
查看歷史版本
發布歷史保留最近10次。
雲原生API Gateway提供了執行個體內和執行個體外兩種查看歷史版本的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API，然後單擊發布歷史頁簽。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API，然後單擊發布歷史頁簽。
單擊目標歷史版本操作列下的查看，可查看歷史版本詳情。
產生SDK與文檔
雲原生API Gateway提供了執行個體內和執行個體外兩種產生SDK與文檔的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API。單擊右上方的。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API。
單擊右上方的。
在SDK&文檔產生對話方塊中，配置相關參數，然後單擊產生並下載。
配置項
說明
API版本
選擇要產生SDK與文檔的API版本。
說明執行個體內建立API無版本管理能力，無該選項。
執行個體外建立API選擇是否啟用API版本管理能力。若建立API時未啟用版本管理，則無該選項。
SDK語言
目前支援的SDK語言：Java、Golang、Python、Node.js、TypeScript、Swift。
等待產生SDK及相關文檔後，瀏覽器將自動下載SDK及相關文檔的壓縮包至您的本機電腦，您可以到瀏覽器預設下載路徑中進行查看。
說明解壓完成後，您可以參考
README.md文檔作為SDK的使用指南，該文檔包含了使用SDK所需的基本資料。
匯入API
雲原生API Gateway提供了執行個體內和執行個體外兩種匯入API的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API。單擊右上方的。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API。
單擊右上方的。
在基於OpenAPI建立檔案面板中配置相關參數，然後單擊預檢並建立。
匯出API
雲原生API Gateway提供了執行個體內和執行個體外兩種匯出API的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API。單擊右上方的。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API。
單擊右上方的。
在匯出對話方塊中，單擊確認。瀏覽器會將API下載至本地預設下載路徑中。
下線API
下線後，所有相關網域名稱將無法訪問該API下的介面。雖然API執行個體將停止處理請求，但其配置和記錄仍會保留在系統中，請謹慎執行此操作。
雲原生API Gateway提供了執行個體內和執行個體外兩種下線API的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API。單擊右上方的。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API。
單擊右上方的。
在確認下線對話方塊中，單擊下線。
刪除API
若當前API存在發行的執行個體，需所有執行個體下線後再進行刪除操作。
刪除API將徹底移除API的配置、文檔和記錄，且不可恢複，請謹慎執行此操作。
雲原生API Gateway提供了執行個體內和執行個體外兩種刪除API的方式：
執行個體外API
登入雲原生API Gateway控制台。左側導覽列選擇API，並在頂部功能表列選擇地區。
單擊目標API。單擊右上方的。
執行個體內API
登入雲原生API Gateway控制台。左側導覽列選擇執行個體，並在頂部功能表列選擇地區。
在執行個體頁面，單擊目標網關執行個體ID。左側導覽列選擇API，單擊目標API。
單擊右上方的。
在確認刪除對話方塊中，單擊刪除。