基礎(chǔ)術(shù)語
本文將對 API 網(wǎng)關(guān)中常見的基礎(chǔ)術(shù)語進行說明。
中文 | 釋義 |
API | 應(yīng)用程序編程接口,是一些預(yù)先定義的函數(shù),或指軟件系統(tǒng)不同組成部分銜接的約定。 |
API 分組 | 用于將 API 進行邏輯的分組,同個分組下的 API 使用相同的分組標識做隔離。 |
分組標識 | 是網(wǎng)關(guān)全局的唯一標識,用于定位在訪問的 API。 |
默認二級域名 | 客戶端使用 HTTP 協(xié)議訪問網(wǎng)關(guān)時使用,由分組標識+網(wǎng)關(guān)的二級域名組成。 |
SSL | 安全套接字層,是一種標準協(xié)議,用于加密瀏覽器和服務(wù)器之間的通信。 |
前端協(xié)議類型 | 是指客戶端請求到網(wǎng)關(guān)時使用的協(xié)議類型。 |
HTTP | 超文本傳輸協(xié)議。 |
SOFARPC | 螞蟻集團自研的 RPC 調(diào)用框架。 |
請求路徑 | 表示請求的資源的 URI(統(tǒng)一資源標識符,Uniform Resource Identifier),通過請求路徑可以定位到要請求的資源。 |
絕對匹配 | 調(diào)用的請求路徑固定為創(chuàng)建時填寫的 API 請求 Path。 |
前綴匹配 | 只要請求路徑前綴相同則都匹配到這個接口上,實現(xiàn)接口定義多個不同 Path。 |
HTTP 方法 | 表明要對給定的 HTTP 資源執(zhí)行的操作。 |
請求參數(shù) | 表示客戶端向網(wǎng)關(guān)發(fā)起請求時要配置的參數(shù)。 |
header 參數(shù) | 報文頭包含若干個屬性,格式為“屬性名:屬性值”,服務(wù)端據(jù)此獲取客戶端的信息。 |
query 參數(shù) | 一般是指 URL 中 |
請求 body 參數(shù) | 指請求體中的數(shù)據(jù)。 |
響應(yīng)參數(shù) | 用于對響應(yīng)內(nèi)容進行解釋。 |
響應(yīng) body 參數(shù) | 用于解釋響應(yīng)體里的參數(shù)含義。 |
響應(yīng)示例 | 用于示例響應(yīng)的狀態(tài)。 |
業(yè)務(wù)錯誤碼 | 用于解釋響應(yīng)里的業(yè)務(wù)錯誤碼代表的意思。 |
接口全名 | RPC 接口的接口命名,就完成某些特定功能的類,是一個功能的集合。 |
RPC 方法 | RPC 接口里的方法,表明要資源執(zhí)行的具體操作。 |
OperationType | 針對 mPaaS 移動應(yīng)用設(shè)置的 API 服務(wù)標識,用于定位要訪問的資源。 |
后端服務(wù)類型 | 表示網(wǎng)關(guān)接收到請求后轉(zhuǎn)發(fā)給的后端服務(wù)類型。 |
后端協(xié)議類型 | 表示網(wǎng)關(guān)接收到請求后轉(zhuǎn)發(fā)給的后端服務(wù)使用的通信協(xié)議類型。 |
報文類型 | 表示請求和響應(yīng)中的媒體類型信息,告訴服務(wù)端如何處理請求的數(shù)據(jù),以及告訴客戶端(一般是瀏覽器)如何解析響應(yīng)的數(shù)據(jù)。 |
報文編碼 | 客戶端接受字符集樣式的文本內(nèi)容。 |
MOCK | 如果接口后端還沒有提供,使用 Mock 用于模擬一個后端服務(wù)。 |
系統(tǒng)集群 | 表示網(wǎng)關(guān)接收到前端請求后轉(zhuǎn)發(fā)到真實業(yè)務(wù)系統(tǒng)的集群。 |
地址配置方式 | 表示系統(tǒng)集群的地址來源。 |
集群地址 | 表示系統(tǒng)集群的地址,可以是 IP 地址,也可以是域名。 |
負載均衡 | 當后端地址大于 1 個時使用的負載均衡策略。 |
后端認證方式 | 表示網(wǎng)關(guān)向后端業(yè)務(wù)系統(tǒng)發(fā)送請求時是否要加簽。 |
路由規(guī)則 | 表示當網(wǎng)關(guān)接收到語法后使用的路由策略。 |
應(yīng)用 | 表示非 mPaaS 移動應(yīng)用以外的應(yīng)用。 |
mPaaS 移動應(yīng)用 | 表示 mPaaS 移動應(yīng)用,必須和 mPaaS 移動開發(fā)平臺一起使用。 |