REST API主要面向以業務為中心的開發團隊，適用于API First、API精細化管理等場景，支持通過控制臺、AI大模型或者基于OpenAPI 導入的方式創建。本文主要介紹如何創建REST API并添加接口。
概述
API是一個整體的服務定義，定義了如何與系統進行交互的規則和方法，包含一系列接口；通過API，您可以調用預定義的功能、訪問數據資源或觸發系統行為，而無需了解底層實現的復雜細節。而接口是API的具體實現部分，提供了訪問和操作API功能的入口點，每個接口通常對應一個特定的功能或服務。通過接口，客戶端應用可以與服務器進行交互，執行所需的操作并獲取響應結果。
通過控制臺創建并添加接口
創建API
登錄云原生API網關控制臺。
在左側導航欄，單擊API管理，并在頂部菜單欄選擇地域。
在API管理頁面，單擊創建API，單擊REST API卡片中的創建。
在創建HTTP API面板中，根據頁面提示配置API相關參數。
配置項
說明
API名稱
自定義創建的API名稱。
重要API名稱必須全局唯一。
協議
支持HTTP、HTTPS。
Base Path
API的基本路徑，訪問具體接口時，完整路徑為
http(s)://{域名}/{apiBasePath}/{接口Path}。版本管理
是否啟用API版本管理能力，不同版本的API視為獨立的API，它們具有相同的API名稱，但API的其他基本信息和接口信息可以不同。訪問時需要指定版本標識符。
開啟版本管理功能后，需要配置版本號及使用方式。
說明選擇使用方式為Query時，需要配置參數項添加Query。
選擇使用方式為Header時，需要配置參數項添加Header。
版本號
相同API名稱下，以版本號進行區分。
使用方式
支持Path、Query、Header三種方式。
使用Path時，需要完整訪問路徑為：/API基本路徑/版本號/接口路徑。
使用Query時，完整訪問路徑為：/API基本路徑/接口路徑，請求參數中需要配置參數項添加Query為版本號。
使用Header時，完整訪問路徑為：/API基本路徑/接口路徑，請求頭中需要配置參數項添加Header為版本號。
描述
填寫API的相關描述。
添加API接口
登錄云原生API網關控制臺。
在左側導航欄，單擊API管理，并在頂部菜單欄選擇地域。
在API列表中單擊目標API，在API詳情頁，添加接口：
如果目標API開啟了版本管理，需要先選擇版本，后單擊添加接口。
如果目標API未開啟版本管理，單擊添加接口。
在創建接口面板中，配置接口相關參數，并單擊創建。
配置項
說明
接口名稱
自定義創建的接口名稱，在API下需要全局唯一。
接口Path
接口的具體路徑。
Method
接口的請求方法。接口的路徑+接口的方法，需要在API下全局唯一。
描述
接口的描述信息。
請求定義
支持定義Header、Query、Parameter Path參數以及Body參數。
其中Path參數支持在接口Path中三種定義變量的方式：
/books/{bookId}
/books/[bookId]
/books/:bookId
其中，推薦使用{bookId}方式進行定義。
請求定義僅用于生成SDK和文檔，不對運行時進行校驗。
響應定義
定義不同響應碼的數據結構。
響應碼定義僅用于生成SDK和文檔，不對運行時進行校驗。
Mock
Mock配置僅在API發布Mock場景下生效。
通過AI大模型創建并添加接口
登錄云原生API網關控制臺。
在左側導航欄，選擇API管理，并在頂部菜單欄選擇地域。
在API管理頁面，單擊創建API，選擇REST API卡片中的AI大模型創建。
在基于AI大模型創建面板中，根據頁面提示配置相關參數，單擊生成Swagger示例，在左側自動生成API及接口。
配置項
說明
API名稱
自定義創建的API名稱。
重要API名稱必須全局唯一。
場景
描述API的使用場景，是關于什么的服務。
資源及對應操作
數據對象，最多創建5個數據對象
名稱
數據對象的名稱，如圖書。
屬性
數據對象的屬性，如書名、作者，可直接粘貼數據模型相關的定義文本或代碼。
操作：增/刪/改/查
增：新增資源接口描述，如根據ID、名稱新增。
刪：刪除資源接口描述，如根據ID刪除資源。
改：修改資源接口描述，如根據ID，修改資源名稱。
查：查看資源接口描述，如根據ID查詢資源信息
其他
填寫其他補充內容。
通過導入OpenAPI文件創建并添加接口
登錄云原生API網關控制臺。
在左側導航欄，選擇API管理，并在頂部菜單欄選擇地域。
在API管理頁面，單擊創建API，單擊REST API卡片中的導入。
在基于OpenAPI創建文件面板中，配置API相關參數，并單擊預檢并創建。
配置項
說明
API名稱
自定義創建的API名稱，API名稱需要全局唯一。
OpenAPI文件
支持選擇文件或粘貼文本內容。
版本管理
是否啟用API版本管理能力，不同版本的API視為獨立的API，它們具有相同的API名稱，但API的其他基本信息和接口信息可以不同。訪問時需要指定版本標識符。
開啟版本管理功能后，需要配置版本號及使用方式。
說明選擇使用方式為Query時，需要配置參數項添加Query。
選擇使用方式為Header時，需要配置參數項添加Header。
版本號
相同API名稱下，以版本號進行區分。
使用方式
支持Path、Query、Header三種方式。
使用Path時，需要完整訪問路徑為：/API基本路徑/版本號/接口路徑。
使用Query時，完整訪問路徑為：/API基本路徑/接口路徑，請求參數中需要配置參數項添加Query為版本號。
使用Header時，完整訪問路徑為：/API基本路徑/接口路徑，請求頭中需要配置參數項添加Header為版本號。
描述
填寫API的相關描述。