步驟一：創建API

步驟二：添加接口

1. 在API列表中單擊目標API，在API詳情頁，添加接口：

   • 如果目標API開啟了版本管理，需要先選擇版本，后單擊添加接口。

     

   • 如果目標API未開啟版本管理，單擊添加接口。

2. 在創建接口面板中，配置接口相關參數，并單擊創建。

   配置項		說明
   接口名稱		自定義創建的接口名稱，在API下需要全局唯一。
   接口Path		接口的具體路徑。
   方法		接口的請求方法。接口的路徑+接口的方法，需要在API下全局唯一。
   描述		接口的描述信息。
   API定義信息	請求定義	支持定義Header、Query、Parameter Path參數以及Body參數。 其中Path參數支持在接口Path中三種定義變量的方式： /books/{bookId} /books/[bookId] /books/:bookId 其中，推薦使用{bookId}方式進行定義。 說明 請求定義僅用于生成SDK和文檔，不對運行時進行校驗。
   	響應定義	定義不同響應碼的數據結構。 響應碼定義僅用于生成文檔，不對運行時進行校驗。
   	Mock	Mock配置僅在API發布Mock場景下生效。

步驟一：創建API

1. 登錄云原生API網關控制臺。

2. 在左側導航欄，選擇API，并在頂部菜單欄選擇地域。

3. 在API管理頁面，單擊創建API，單擊REST API卡片中的導入。

4. 在基于OpenAPI創建文件面板中，配置API相關參數，并單擊預檢并創建。

   配置項	說明
   API名稱	自定義創建的API名稱，API名稱需要全局唯一。
   上傳方式	支持本地文件、OSS文件導入。
   OpenAPI文件	支持選擇文件或粘貼文本內容，限制文件大小在30M內。
   版本管理	是否啟用API版本管理能力，不同版本的API視為獨立的API，它們具有相同的API名稱，但API的其他基本信息和接口信息可以不同。訪問時需要指定版本標識符。 開啟版本管理功能后，需要配置版本號及使用方式。 說明 選擇使用方式為Query時，需要配置參數項添加Query。 選擇使用方式為Header時，需要配置參數項添加Header。
   版本號	相同API名稱下，以版本號進行區分。
   使用方式	支持Path、Query、Header三種方式。 使用Path時，需要完整訪問路徑為：/API基本路徑/版本號/接口路徑。 使用Query時，完整訪問路徑為：/API基本路徑/接口路徑，請求參數中需要配置參數項添加Query為版本號。 使用Header時，完整訪問路徑為：/API基本路徑/接口路徑，請求頭中需要配置參數項添加Header為版本號。
   描述	填寫API的相關描述。

5. 創建成功后，可在接口列表中查看OpenAPI中定義的接口信息。

步驟二：發布API

1. 在API列表中，單擊需要發布的API，進入API詳情頁面，單擊右上角發布API。

2. 在發布面板中，配置相關參數，并單擊確定。

   配置項	說明
   域名	選擇對應的域名進行發布，發布后，支持通過相關域名訪問API。 若無域名，可單擊創建域名，具體操作，請參見創建域名。
   環境/網關/VPC	將API發布到指定環境。若無發布環境，可單擊創建環境，具體操作，請參見環境管理。 重要 若該環境下API已發布，則本次發布將覆蓋已發布數據，請謹慎操作。
   使用場景	支持Mock、單服務、按比例（多服務）、按內容（多服務）等場景進行發布。 Mock場景 Mock場景，接口的響應將返回接口定義中的Mock配置，若接口未定義Mock配置，則將無法訪問該接口。 發布Mock場景時，要求當前API中至少有一個接口開啟了Mock配置，否則將發布失敗。 單服務場景 單服務場景，所有流量將轉發到某一具體的后端服務。 按比例場景 按比例場景，所有的流量將按比例分發到對應的后端服務中。 說明 要求多個條目的服務權重之和等于100。 按內容場景 按內容場景，所有的流量將按照匹配條件分發到對應的后端服務中，若匹配條件勾選默認，則無其他匹配規則命中時，流量將進入該條目所對應后端服務。 匹配條件支持：等于、前綴是、正則匹配。 參數類型支持：Query、Header。 多個匹配條件之間為“且”運算邏輯。 重要 要求多個條目中，只允許一個條目勾選默認，且其余條目的匹配條件非空。
   后端服務	關聯該環境/網關/VPC下的后端服務。若該環境下無后端服務，可單擊創建服務創建，具體操作，請參考創建服務。
   發布描述	填寫API的發布描述。

步驟三：調試API

1. 在API列表中，單擊目標API，進入API詳情頁，在接口列表中選擇需要調試的接口，單擊調試接口。

   

2. 在調試接口面板中，配置相關參數進行調試。

   

步驟四：通過域名訪問API

1. 在API列表中，選擇目標API，單擊API詳情。

2. 在API詳情頁中，可查看當前API的發布信息。

   在發布信息中，有兩種域名類型：

   • 環境二級域名：系統自動生成，可直接進行訪問的公網域名。公網域名僅供API測試使用，直接訪問時，每天有100次訪問限制。

   • 域名：用戶自定義域名，在發布時進行的配置。用戶需將該自定義域名CNAME映射到對應的公網二級域名，以實現通過域名對API的訪問。通過該方式，將不再受限于公網二級域名100次的訪問上限。

   最終對外可訪問的路徑為：http(s)://{域名}/{BasePath}/接口路徑。

步驟五：下線API

1. 在API列表中，選擇目標API，進入API詳情頁，單擊API詳情頁簽。

   

2. 在發布信息欄中，單擊需要下線的發布記錄操作列中的下線。

   

3. 在確認下線彈窗中，單擊下線。

   重要

   下線后，無法再通過相關域名訪問該API下的所有接口，請謹慎操作。