屬性

必填項

說明

API 名稱

是

• 用于識別 API。

• 支持中文、英文、數字、下劃線（_）、連接符（-），且只能以英文和中文開頭。32 個字符以內。

• 同一個 工作空間下 API 名稱不能相同。

是否基于已有API創建

否

• 默認關閉

• 開啟后可選擇已創建的 API 作為模板。

API 分組

是

• 用于將 API 進行邏輯的分組，分組下的 API 相同的分組 ID 進行隔離。

• 同一個環境下，API 分組名稱不能相同。

• API 分組名稱：支持英文字母、中文、數字、下劃線（_）、連接符（-），32 個字符以內。

API 描述

否

用于描述 API 的作用等，64 個字符以內。

應用

是

• 應用：表示 API 發布后支持 web 瀏覽器、H5 容器、小程序、JS、業務系統的調用。

• mPaas移動應用：表示 API 發布后支持 mPaaS 移動客戶端（iOS、Android）的調用。

• 應用以及 mPaas 移動應用：表示 API 發布后支持 web 瀏覽器、H5 容器、小程序、JS、業務系統的調用，同時也支持 mPaaS 移動客戶端（iOS、Android）的調用。

OperationType

是

• 針對 mPaaS 移動應用設置的 API 服務標識，用于定位要訪問的資源。

• 支持英文字母、數字、英文句號（.），200 字符以內。

• 需按照 com.xxx.opt1的格式輸入。

請求路徑

是

• 表示請求的資源的 URL，通過請求路徑可以定位到要請求的資源。

• 支持英文字母、數字、下劃線（_）、連接符（-），200 字符以內。

• 以斜杠（/ ）開頭，不能以斜杠（/ ）結尾，格式示例：/getUserInfo。

• 支持占位符模式 /home/{id}，如果需要占位符透傳控制面，API 的后端請求路徑需要為空。

方法

是

表明要對給定的 HTTP 資源執行的操作：

• GET：檢索服務器中的數據。

• POST：將數據發送到服務器進行處理。

• PUT：更新服務器中存儲的數據。

• DELETE：刪除服務器中的數據。

路徑匹配規則

是

• 絕對匹配：調用時完全匹配以上填寫的路徑，例如：/path。

• 前綴匹配：以請求路徑為前綴，可匹配多個前綴一樣的不同路徑，例如：填寫 /path的匹配效果為 /path/*。

安全認證

是

• 根據實際需要自行選擇。支持密鑰認證、無需認證、OAuth 認證、Key-Auth 認證、Basic-Auth 認證和 JWT 認證。

接口名稱

是

• 客戶端 RPC 服務或者 DUBBO 服務需要訂閱的接口名稱。

• API 接口名稱，支持英文字母、數字、英文句號（.）、冒號（:）、@，以小寫字母作為開頭。

• 格式示例：com.alipay.testapp.facade.ConfigFacade:1.0@DEFAULT。

服務標識

否

選填，支持通過 uniqueId 指定服務。

方法名

是

• 客戶端 RPC 服務或者 DUBBO 服務需要訂閱的接口名稱。

• API 服務方法名，支持英文字母、數字組成，以字母作為開頭。

• 格式示例：getUserID。

報文類型

是

表示請求和響應中的媒體類型信息，用來告訴服務端如何處理請求的數據，以及告訴客戶端（一般是瀏覽器）如何解析響應的數據。

報文編碼

是

表示客戶端接受文本內容的字符集樣式。

實體參數

否

客戶端 DUBBO 服務接口方法使用的實體參數全路徑，例如：Ljava/lang/String，自定義參數實體時注意以分號（；）結尾。

返回參數

否

客戶端 DUBBO 服務接口方法返回參數全路徑，例如：Ljava/lang/String，自定義參數實體時注意以分號（；）結尾。

DUBBO 分組

否

客戶端 DUBBO 服務接口訂閱時的服務分組。

屬性

必填項

說明

參數名

否

參數的唯一標識。

參數位置

否

• Header：自定義 API 請求頭。例如 X-MyHeader: Value。

• Query：參數在請求 URL 末尾的問號 ?之后以 name=value形式出現。參數之間以 &分隔。例如 /users?role=admin&id=12345。

類型

否

• String

• Int

• Long

• Double

• Float

• Boolean

默認值

否

在 API 請求的參數值為空時使用的默認值。 默認值類型必須和參數類型一致。

描述

否

參數的業務描述。

請求 Body 類型

否

請求 Body 類型表示客戶端向網關發起請求時要配置的參數，可以依賴已經創建數據模型。

API 在使用編排功能時必須選擇數據模型才能實現參數轉換以及透傳，在 API 分組中若想要生成 SDK 必須在請求 Body 或者響應 Body 選擇數據模型才能成功。

• Long

• Int

• Float

• Double

• Boolean

• Byte

• Short

• String

• List：可以選擇基礎類型或者數據模型作為參數模板。

• Object：需要選擇數據模型作為參數模板。

• Map：可以選擇基礎類型或者數據模型作為參數模板。

屬性

必填項

說明

成功響應示例

否

為 API 訂閱者提供請求成功時的返回數據參考。

失敗響應示例

否

為 API 訂閱者提供請求失敗時的返回數據參考。

錯誤碼

否

HTTP 默認錯誤代碼。

錯誤信息

否

自定義錯誤提示信息。

描述

否

錯誤碼的業務描述。

響應body類型

否

響應的參數，可以依賴數據模型

API 在使用編排功能時必須選擇數據模型才能實現參數轉換以及透傳，在 API 分組中若想要生成 SDK 必須在請求 Body 或者響應 Body 選擇數據模型才能成功。

• Long

• Int

• Float

• Double

• Boolean

• Byte

• Short

• String

• List：可以選擇基礎類型或者數據模型作為參數模板。

• Object：需要選擇數據模型作為參數模板。

• Map：可以選擇基礎類型或者數據模型作為參數模板。

屬性

必填項

說明

后端服務類型

是

表示網關接收到請求后轉發給的后端服務類型：

• Mock：表示如果接口后端還沒有提供，使用 Mock 用于模擬一個后端服務。

• 系統集群：表示網關接收到前端請求后轉發到真實業務系統的集群。

協議類型

是

表示網關接收到請求后轉發給的后端服務使用的通信協議類型：

• HTTP

• SOFARPC

• SOFAREST

• DUBBO

• DUBBOX

請求路徑

否

服務端的實際請求路徑，不填默認使用 API 定義中的請求路徑。

路徑截取級數

否

僅支持數字格式。

拼接路徑前綴

否

表示請求到后端時顯示的路徑信息，必須以 / 開頭，但不能以 / 結尾。

超時時間

是

API 請求超時時間，單位為毫秒（ms），默認 3000 毫秒。

路由策略

是

表示當網關接收到語法后使用的路由策略：

• 根據 Header 路由：根據 Header 里帶的參數路由

• 根據 LDC 路由：使用 LDC 單元化路由。

• 根據權重路由：數值范圍為 0-100，所有規則加起來為 100。

• 根據請求路徑路由：直接轉發。

接口名稱

是

• 服務端 RPC 服務、SOFAREST、DUBBO 服務發布的接口名稱。

• API 接口名稱，支持英文字母、數字、英文句號（.）、冒號（:）、@，以小寫字母作為開頭。

• 格式示例：com.alipay.testapp.facade.ConfigFacade:1.0@DEFAULT。

方法名

是

• 服務的 RPC 服務或者 DUBBO 服務需要訂閱的接口方法名稱。

• API 服務方法名，支持英文字母、數字組成，以字母作為開頭。

• 格式示例：getUserID。

實體參數

否

服務端 DUBBO 服務接口方法使用的實體參數全路徑，例如：Ljava/lang/String，自定義參數實體時注意以分號（；）結尾。

返回參數

否

服務端 DUBBO 服務接口方法返回參數全路徑，例如：Ljava/lang/String，自定義參數實體時注意以分號（；）結尾。

DUBBO 分組

否

服務端 DUBBO 服務接口訂閱時的服務分組。

系統集群

是

選擇后端需要綁定的系統集群。

參數映射配置

否

配置響應參數和請求參數映射，可選已創建的參數映射規則。