全部產品
Search
文件中心

API Gateway:建立REST API並添加介面

更新時間:Sep 12, 2025

雲原生API Gateway提供執行個體內與執行個體外兩種建立API的方式。可通過控制台或者基於OpenAPI匯入方式建立API。本文介紹如何建立REST API以及如何添加介面。

適用情境

雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式,分別適用以下情境:

執行個體內建立API

  • 資源的專用管理:API僅需在特定執行個體內使用,管理特定資源或內部邏輯。

  • 安全性和隔離性:資料或功能需要嚴格隔離以確保安全性,僅在執行個體內調用。

  • 簡化服務配置:簡化在特定執行個體中的API配置和管理。

執行個體外建立API

  • 跨執行個體共用訪問:多個執行個體共用 API 定義資訊。

  • 集中管理和監控:統一許可權控制、日誌記錄和流量管理。

通過控制台建立REST API

雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式:

執行個體外API

  1. 登入雲原生API Gateway控制台

  2. 單擊左側導覽列API,並在頂部功能表列選擇地區。

  3. 單擊建立API

  4. 單擊REST API卡片中的建立,在建立REST API面板中配置相關參數,單擊確認。

    配置項

    說明

    API名稱

    自訂建立的API名稱,API名稱必須全域唯一。

    Base Path

    API的基本路徑,訪問具體介面時,完整路徑為http(s)://{網域名稱}/{BasePath}/{介面Path}

    版本管理

    是否啟用API版本管理能力,不同版本的API視為獨立的API,它們具有相同的API名稱,但API的其他基本資料和介面資訊可以不同。訪問時需要指定版本標識符。

    開啟版本管理功能後,需要配置使用方式

    說明
    • 選擇使用方式Query時,需要配置參數項添加Query

    • 選擇使用方式Header時,需要配置參數項添加Header

    使用方式

    支援PathQueryHeader三種方式。

    • 使用Path時,需要完整訪問路徑為:/API基本路徑/版本號碼/介面路徑。

    • 使用Query時,完整訪問路徑為:/API基本路徑/介面路徑,請求參數中需要配置參數項添加Query為版本號碼。

    • 使用Header時,完整訪問路徑為:/API基本路徑/介面路徑,要求標頭中需要配置參數項添加Header為版本號碼。

    描述

    填寫API的相關描述。

    資源群組

    選擇目標資源群組。您可單擊右側的建立資源群組

單擊建立API

  1. 單擊REST API卡片中的建立,在建立REST API面板中配置相關參數,單擊確認。

    配置項

    說明

    API名稱

    自訂建立的API名稱,API名稱必須全域唯一。

    Base Path

    API的基本路徑,訪問具體介面時,完整路徑為http(s)://{網域名稱}/{BasePath}/{介面Path}

    版本管理

    是否啟用API版本管理能力,不同版本的API視為獨立的API,它們具有相同的API名稱,但API的其他基本資料和介面資訊可以不同。訪問時需要指定版本標識符。

    開啟版本管理功能後,需要配置使用方式

    說明
    • 選擇使用方式Query時,需要配置參數項添加Query

    • 選擇使用方式Header時,需要配置參數項添加Header

    使用方式

    支援PathQueryHeader三種方式。

    • 使用Path時,需要完整訪問路徑為:/API基本路徑/版本號碼/介面路徑。

    • 使用Query時,完整訪問路徑為:/API基本路徑/介面路徑,請求參數中需要配置參數項添加Query為版本號碼。

    • 使用Header時,完整訪問路徑為:/API基本路徑/介面路徑,要求標頭中需要配置參數項添加Header為版本號碼。

    描述

    填寫API的相關描述。

    資源群組

    選擇目標資源群組。您可單擊右側的建立資源群組

執行個體內API

  1. 登入雲原生API Gateway控制台

  2. 單擊左側導覽列執行個體,並在頂部功能表列選擇地區。

  3. 執行個體頁面,單擊目標執行個體ID進入概覽頁面。然後單擊左側導覽列API,並單擊建立API

  4. 單擊REST API卡片中的建立,在建立REST API面板中配置相關參數,單擊確認。

    配置項

    說明

    API名稱

    自訂建立的API名稱,API名稱必須全域唯一。

    網域名稱

    • 選擇API需要匹配的網域名稱,支援選擇多個網域名稱。

    • 如果您需要建立新的網域名稱,可以直接單擊添加網域名稱,在面板中進行建立。

    Base Path

    API的基本路徑,訪問具體介面時,完整路徑為http(s)://{網域名稱}/{BasePath}/{介面Path}

    版本管理

    是否啟用API版本管理能力,不同版本的API視為獨立的API,它們具有相同的API名稱,但API的其他基本資料和介面資訊可以不同。訪問時需要指定版本標識符。

    開啟版本管理功能後,需要配置使用方式

    說明
    • 選擇使用方式Query時,需要配置參數項添加Query

    • 選擇使用方式Header時,需要配置參數項添加Header

    使用方式

    支援PathQueryHeader三種方式。

    • 使用Path時,需要完整訪問路徑為:/API基本路徑/版本號碼/介面路徑。

    • 使用Query時,完整訪問路徑為:/API基本路徑/介面路徑,請求參數中需要配置參數項添加Query為版本號碼。

    • 使用Header時,完整訪問路徑為:/API基本路徑/介面路徑,要求標頭中需要配置參數項添加Header為版本號碼。

    描述

    填寫API的相關描述。

    資源群組

    選擇目標資源群組。您可單擊右側的建立資源群組

    使用情境

    選擇當前介面的使用情境。

    • 基礎情境:單服務

    • 灰階情境:按比例(多服務)按內容(多服務)標籤路由(按比例)

    說明

    涉及權重的目標服務流量比例總和要求為100%。

    後端服務

    關聯該網關/VPC下的後端服務。若該網關下無後端服務,可單擊建立服務建立。

    重要

    在建立服務時,服務連接埠資訊可能不會立即顯示。您需要展開服務名稱的下拉式清單並單擊重新整理。由於連接埠資訊同步是非同步進行的,可能需要稍等片刻才能載入並顯示完整的服務連接埠資訊。

通過匯入OpenAPI檔案建立REST API

雲原生API Gateway提供了執行個體內和執行個體外兩種建立API的方式:

執行個體外API

  1. 登入雲原生API Gateway控制台

  2. 單擊左側導覽列API,並在頂部功能表列選擇地區。

  3. 單擊建立API

  4. 單擊REST API卡片中的匯入,在基於OpenAPI建立檔案面板中配置相關參數,單擊預檢並建立

    配置項

    說明

    API名稱

    自訂建立的API名稱,API名稱必須全域唯一。

    上傳方式

    支援本地檔案OSS檔案匯入

    說明

    本地檔案與OSS檔案匯入中的檔案均符合OpenAPI規範。

    OpenAPI檔案

    在選擇本地檔案時配置,支援選擇檔案或粘貼常值內容,限制檔案大小在30M內。

    Region選擇

    在選擇OSS檔案匯入時配置,選擇地區,以便選擇其OSS資源。

    OSS Bucket

    在選擇OSS檔案匯入時配置,選擇OSS Bucket,暫不支援無地區屬性的Bucket。

    版本管理

    是否啟用API版本管理能力,不同版本的API視為獨立的API,它們具有相同的API名稱,但API的其他基本資料和介面資訊可以不同。訪問時需要指定版本標識符。

    開啟版本管理功能後,需要配置使用方式

    說明
    • 選擇使用方式Query時,需要配置參數項添加Query

    • 選擇使用方式Header時,需要配置參數項添加Header

    使用方式

    支援PathQueryHeader三種方式。

    • 使用Path時,需要完整訪問路徑為:/API基本路徑/版本號碼/介面路徑。

    • 使用Query時,完整訪問路徑為:/API基本路徑/介面路徑,請求參數中需要配置參數項添加Query為版本號碼。

    • 使用Header時,完整訪問路徑為:/API基本路徑/介面路徑,要求標頭中需要配置參數項添加Header為版本號碼。

    描述

    填寫API的相關描述。

    資源群組

    選擇目標資源群組。您可單擊右側的建立資源群組

執行個體內API

  1. 登入雲原生API Gateway控制台

  2. 單擊左側導覽列執行個體,並在頂部功能表列選擇地區。

  3. 執行個體頁面,單擊目標執行個體ID進入概覽頁面。然後單擊左側導覽列API,並單擊建立API

  4. 單擊REST API卡片中的匯入。在基於OpenAPI建立檔案面板中配置相關參數,單擊預檢並建立

    配置項

    說明

    API名稱

    自訂建立的API名稱,API名稱必須全域唯一。

    網域名稱

    • 選擇API需要匹配的網域名稱,支援選擇多個網域名稱。

    • 如果您需要建立新的網域名稱,可以直接單擊添加網域名稱,在面板中進行建立。

    上傳方式

    支援本地檔案OSS檔案匯入

    說明

    本地檔案與OSS檔案匯入中的檔案均符合OpenAPI規範。

    OpenAPI檔案

    在選擇本地檔案時配置,支援選擇檔案或粘貼常值內容,限制檔案大小在30M內。

    Region選擇

    在選擇OSS檔案匯入時配置,選擇地區,以便選擇其OSS資源。

    OSS Bucket

    在選擇OSS檔案匯入時配置,選擇OSS Bucket,暫不支援無地區屬性的Bucket。

    版本管理

    是否啟用API版本管理能力,不同版本的API視為獨立的API,它們具有相同的API名稱,但API的其他基本資料和介面資訊可以不同。訪問時需要指定版本標識符。

    開啟版本管理功能後,需要配置使用方式

    說明
    • 選擇使用方式Query時,需要配置參數項添加Query

    • 選擇使用方式Header時,需要配置參數項添加Header

    使用方式

    支援PathQueryHeader三種方式。

    • 使用Path時,需要完整訪問路徑為:/API基本路徑/版本號碼/介面路徑。

    • 使用Query時,完整訪問路徑為:/API基本路徑/介面路徑,請求參數中需要配置參數項添加Query為版本號碼。

    • 使用Header時,完整訪問路徑為:/API基本路徑/介面路徑,要求標頭中需要配置參數項添加Header為版本號碼。

    描述

    填寫API的相關描述。

    資源群組

    選擇目標資源群組。您可單擊右側的建立資源群組

    使用情境

    選擇當前介面的使用情境。

    • 基礎情境:單服務

    • 灰階情境:按比例(多服務)按內容(多服務)標籤路由(按比例)

    說明

    涉及權重的目標服務流量比例總和要求為100%。

    後端服務

    關聯該網關/VPC下的後端服務。若該網關下無後端服務,可單擊建立服務建立。

    重要

    在建立服務時,服務連接埠資訊可能不會立即顯示。您需要展開服務名稱的下拉式清單並單擊重新整理。由於連接埠資訊同步是非同步進行的,可能需要稍等片刻才能載入並顯示完整的服務連接埠資訊。

添加介面

  1. 在REST API中,單擊添加介面

  2. 建立介面面板中配置相關參數,單擊添加

    配置項

    說明

    介面名稱

    自訂建立的介面名稱,在API下需要全域唯一。

    介面Path

    介面的具體路徑。

    方法

    介面的要求方法。介面的路徑+介面的方法,需要在API下全域唯一。

    描述

    介面的描述資訊。

    請求定義

    支援定義HeaderQueryParameter Path參數以及Body參數。

    其中Path參數支援在介面Path中三種定義變數的方式:

    • /books/{bookId}

    • /books/[bookId]

    • /books/:bookId

    其中,推薦使用{bookId}方式進行定義。

    說明

    請求定義僅用於產生SDK和文檔,不對運行時進行校正。

    響應定義

    定義不同響應碼的資料結構。

    響應碼定義僅用於產生文檔,不對運行時進行校正。

    Mock

    Mock配置僅在API發布Mock情境下生效。

    說明

    執行個體外支援REST API的Mock配置功能,執行個體內暫不支援Mock配置。

    消費者認證

    開啟或關閉消費者認證,預設關閉。開啟消費者認證後,需為當前介面綁定消費者授權關係,否則無法訪問。